connectionParams property

(FutureOr<Map<String, Object?>?> Function()?) connectionParams
final

Optional parameters, passed through the payload field with the ConnectionInit message, that the client specifies when establishing a connection with the server. You can use this for securely passing arguments for authentication.

If you decide to return a promise, keep in mind that the server might kick you off if it takes too long to resolve! Check the connectionInitWaitTimeout on the server for more info.

Throwing an error from within this function will close the socket with the Error message in the close event reason.

Implementation

final FutureOr<Map<String, Object?>?> Function()? connectionParams;