PhoenixLink class

a link for subscriptions (or also mutations/queries) over phoenix channels

Constructors

PhoenixLink({required PhoenixChannel channel, ResponseParser parser = const ResponseParser(), RequestSerializer serializer = const RequestSerializer()})

create a new PhoenixLink using an established PhoenixChannel channel. You can use the static createChannel method to create a PhoenixChannel from a websocket URI and optional parameters (e.g. for authentication)

Properties

channel → PhoenixChannel

the underlying phoenix channel

final

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

concat(Link next) → Link

Adds next after this link

inherited

dispose() → Future<void>

Can be called to clean up resources

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

request(Request request, [NextLink? forward]) → Stream<Response>

A function called when a request reaches this Link

route(LinkRouter route) → Link

Route requests after this link

inherited

split(bool test(Request request), Link left, [Link right = const PassthroughLink()]) → Link

Split requests after this link

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Static Methods

createChannel({required String websocketUri, Map<String, String>? params}) → Future<PhoenixChannel>

create a new phoenix socket from the given websocketUri, connect to it, and create a channel, and join it