connectanum library

Classes

Abort
The WAMP Abort massage
AbstractAuthentication
AbstractMessage
all WAMP messages have an id, this abstract message provides this default existing field
AbstractMessageWithPayload
CALL,EVENT,RESULT,ERROR,PUBLISH,INVOCATION,YIELD may have a transparent payload
AbstractSerializer
The custom serializer interface
AbstractTransport
Authenticate
The WAMP Authenticate massage
BCrypt
BCrypt implements OpenBSD-style Blowfish password hashing using the scheme described in "A Future-Adaptable Password Scheme" by Niels Provos and David Mazieres.
BcryptPbkdf
Broker
BrokerFeatures
Broker feature flags advertised in WAMP WELCOME.Details.
Call
The WAMP Call massage
Callee
CalleeFeatures
Caller
CallerFeatures
CallOptions
Options used influence the call behavior
Cancel
The WAMP Call massage
CancelOptions
Challenge
The WAMP Challenge massage
Client
ClientConnectOptions
ConnectanumE2eeProfile
CraAuthentication
WAMP-CRA authentication implementation (client & router shared).
CryptosignAuthentication
Dealer
DealerFeatures
Details
DisposableWampE2eeProvider
DrainableTransport
Optional cooperative flow-control point after buffered writes are handed to the underlying connection. Completion does not acknowledge remote receipt.
E2EEPayload
Error
The WAMP Error massage
Event
EventDetails
Options used influence the event behavior
Extra
Challenge values to check the authentication validity
FileSegmentTransport
Optional transport capability for file-backed WAMP message payloads.
Goodbye
GoodbyeMessage
Heartbeat
Hello
Interrupt
InterruptOptions
Invocation
InvocationDetails
LazyEventPayload
LazyInvocationPayload
LazyMessagePayload
A payload view that delays decoding until an application reads its values.
LazyResultPayload
LazyStringKeyMap<T>
Lazily materializes string-keyed maps the first time their unresolved contents are accessed.
LocalTransport
McpCompletionArgument
The argument name and partial value supplied to a completion provider.
McpCompletionContext
Previously resolved prompt or URI-template arguments.
McpCompletionReference
A prompt or resource-template definition referenced by MCP completion.
McpCompletionRequest
A typed completion/complete request body.
McpCompletionResult
A bounded completion result as defined by MCP.
McpPromptReference
Identifies a prompt whose argument is being completed.
McpResourceTemplateReference
Identifies a resource URI or URI-template whose argument is being completed.
McpResourceUriTemplate
A bounded RFC 6570 Level 1 template for an MCP resource URI.
Message
The message structure defined by the WAMP-Protocol
MessageTypes
NativeE2eeFileSegmentTransport
NativeRawSocketTransport
NativeWampCborAes256GcmProvider
NativeWampCborXsalsa20Poly1305Provider
NativeWebSocketTransport
NegotiatedSessionE2ee
Pem
Pkcs8
Ppk
PpkMacData
PPTOptions
Payload PassThru Options are the same across all wamp messages this provides a common checks for them
PPTPayload
ProgressiveCall
Publish
Published
Publisher
PublisherFeatures
PublishOptions
Register
Registered
RegisterOptions
Result
ResultDetails
RetryDeduplication
Bounded router-side handling for application retry transaction hashes.
Roles
ScramAuthentication
WAMP-SCRAM authentication with asynchronous password-key derivation.
ScramKeyCacheBinding
Exact derivation inputs that bind a reusable SCRAM client/server key pair.
ScramKeyDerivationRequest
Inputs for a single SCRAM password-key derivation.
ScramKeyDerivationTask
A running key derivation that can be terminated independently.
ScramKeyDeriver
Runs expensive SCRAM key derivation away from the caller's event loop.
ScramServerSecrets
Session
SessionE2eeProviderContext
SocketTransport
This class implements the raw socket transport for wamp messages. It is also capable of using connectanums own upgrade method to allow more then 16MB of payload.
Subscribe
Used to subscribe to a topic
Subscribed
Is returned by the subscription process
SubscribeOptions
Used to either define advanced router options such a prefix or wildcard matching or subsciption retention. One may also add custom options, Those custom options need to be added with a custom serializer because flutter disables reflections.
Subscriber
SubscriberFeatures
TicketAuthentication
Ticket-based authentication implementation shared by client and router.
TransportFileSource
An opened file source retained by a transport for file-backed frame sends.
UnknownMessage
Unregister
Unregistered
Unsubscribe
Unsubscribed
UnsubscribedDetails
UriPattern
WampCborAes256GcmProvider
WampCborXsalsa20Poly1305Provider
WampE2eeKeySelectionPolicies
WampE2eeKeySelectionRule
WampE2eePartyContext
WampE2eePolicyAwareProvider
WampE2eeProfileSupport
WampE2eeProvider
WampE2eeRuntimeContext
WampE2eeRuntimePayloadProvider
Opt-in capability for providers that can unpack from runtime-owned payload storage without materializing the outer WAMP arguments first.
WampFileMetadata
Versioned metadata for a progressive WAMP file transfer.
WampFileReceipt
Immutable completion information supplied to WampFileSink.close.
WampFileReceiver
Bounded receiver for the WampFileSession.setFile wire contract.
WampFileSink
Backpressure-aware destination for incoming file chunks.
WampFileSinkConsumesChunks
Opt-in for sinks that stop accessing each chunk when WampFileSink.add completes.
WampFileSource
Re-openable byte source used by WampFileSession.setFile.
WampMetaStateCache
A session-scoped, race-safe view of the standard WAMP Meta API state.
WampMetaStateSnapshot
An immutable snapshot of visible WAMP Meta API state.
WampRegistrationMeta
Standard registration details plus the current callee session IDs.
WampSessionMeta
Standard wamp.session.get details retained by the cache.
WampSubscriptionMeta
Standard subscription details plus the current subscriber session IDs.
WebSocketSerialization
WebSocketTransport
This is a mock class to provide a unified interface for js and native usage of this package
Welcome
Is passed if a session was created by the server after or without an authentication process
Yield
YieldOptions

Enums

AuthenticationStringEncoding
Controls how authentication strings are converted to bytes.
LazyPayloadEncoding
WampE2eeDirection
WampE2eeMessageType

Mixins

CustomFieldContainer
Provides storage for implementation-specific fields on WAMP option/detail objects. Keys follow the WAMP convention of starting with an underscore, but this container does not enforce validation so callers can remain interoperable with peers that use legacy key formats.

Extensions

WampFileSession on Session
High-level progressive file delivery for an established WAMP session.

Constants

defaultWampFileChunkSize → const int
Default chunk size for production file transfers.
wampFileMetadataKey → const String
Metadata key used by the Connectanum progressive file-transfer contract.

Functions

attachLazyStringKeyMapLoader<T>(Map<String, T> map, Map<String, T> loader()) → void
containsMcpWhitespaceOrControl(String value) → bool
decodeLazyPayloadView(LazyMessagePayload payload, {String? pptScheme, String? pptSerializer, String? pptCipher, String? pptKeyId, WampE2eeProvider? e2eeProvider, WampE2eeRuntimeContext? runtimeContext}) → MaterializedPayloadView
decodePayloadView(List? arguments, Map<String, dynamic>? argumentsKeywords, {String? pptScheme, String? pptSerializer, String? pptCipher, String? pptKeyId, WampE2eeProvider? e2eeProvider, WampE2eeRuntimeContext? runtimeContext}) → MaterializedPayloadView
eventFromPayload(EventPayload payload) → Event
lazyStringKeyMap<T>({Map<String, T>? initialValues, Map<String, T> loader()?}) → Map<String, T>
releaseNativeMessagePayload(LazyMessagePayload payload) → bool
Returns false because native message storage is unavailable on this platform.
resultFromLazyPayload(LazyResultPayload payload) → Result
unwrapLazyPayloadView(LazyMessagePayload payload, {String? pptScheme, String? pptSerializer, String? pptCipher, String? pptKeyId, WampE2eeProvider? e2eeProvider, WampE2eeRuntimeContext? runtimeContext}) → LazyMessagePayload
wampFileSourceFromPath(String path, {String? name, String? contentType, String? sha256Digest, Map<String, dynamic>? custom}) → Future<WampFileSource>
Local path sources are only available on Dart IO platforms.

Typedefs

E2EEPayloadView = ({List? arguments, Map<String, dynamic>? argumentsKeywords})
EventPayload = ({List? arguments, Map<String, dynamic>? argumentsKeywords, Map<String, dynamic>? customDetails, String? pptCipher, String? pptKeyId, String? pptScheme, String? pptSerializer, int publicationId, int? publisher, int subscriptionId, String? topic, int? trustlevel})
InvocationPayload = ({List? arguments, Map<String, dynamic>? argumentsKeywords, int? caller, Map<String, dynamic>? customDetails, bool Function() isResponseClosed, String? pptCipher, String? pptKeyId, String? pptScheme, String? pptSerializer, String? procedure, bool progress, bool receiveProgress, int registrationId, int requestId, InvocationPayloadResponder respondWith, int? timeout})
InvocationPayloadResponder = void Function({List? arguments, Map<String, dynamic>? argumentsKeywords, String? errorUri, bool isError, LazyMessagePayload? lazyPayload, YieldOptions? options})
MaterializedPayloadView = ({List? arguments, Map<String, dynamic>? argumentsKeywords})
McpCompletionHandler = FutureOr<McpCompletionResult> Function(McpCompletionRequest request)
Produces completion candidates for one prompt or resource-template argument.
PackedPayloadDecoder = MaterializedPayloadView Function(Uint8List bytes)
PayloadListDecoder = List Function(Uint8List bytes)
PayloadMapDecoder = Map<String, dynamic> Function(Uint8List bytes)
ResultPayload = ({List? arguments, Map<String, dynamic>? argumentsKeywords, int callRequestId, Map<String, dynamic>? customDetails, String? pptCipher, String? pptKeyId, String? pptScheme, String? pptSerializer, bool progress})
SessionE2eeProviderResolver = FutureOr<WampE2eeProvider?> Function(SessionE2eeProviderContext context)
WampE2eeKeySelectionPolicy = String? Function(WampE2eeRuntimeContext runtimeContext, PPTOptions options)
WampFileSinkFactory = FutureOr<WampFileSink> Function(WampFileMetadata metadata)