blob: 2d317d0a69c3cb4722f914c8bb7178877d03c120 [file] [log] [blame]
Matthias Andreas Benkard7b2a3a12021-08-16 10:57:25 +02001<?php
2
3namespace Illuminate\Contracts\Broadcasting;
4
5interface Broadcaster
6{
7 /**
8 * Authenticate the incoming request for a given channel.
9 *
10 * @param \Illuminate\Http\Request $request
11 * @return mixed
12 */
13 public function auth($request);
14
15 /**
16 * Return the valid authentication response.
17 *
18 * @param \Illuminate\Http\Request $request
19 * @param mixed $result
20 * @return mixed
21 */
22 public function validAuthenticationResponse($request, $result);
23
24 /**
25 * Broadcast the given event.
26 *
27 * @param array $channels
28 * @param string $event
29 * @param array $payload
30 * @return void
Matthias Andreas Benkard1ba53812022-12-27 17:32:58 +010031 *
32 * @throws \Illuminate\Broadcasting\BroadcastException
Matthias Andreas Benkard7b2a3a12021-08-16 10:57:25 +020033 */
34 public function broadcast(array $channels, $event, array $payload = []);
35}