Skip to main content
Version: 4.x

DarkWS

DarkWS​

DarkWS Namespace​

Classes
ActionAttributeExposes a declared public instance method returning IResponse or Task of IResponse with zero or one payload parameter.
AspNetDarkWsSessionDefault session for an authenticated ASP.NET principal, without broadcast groups.
BroadcastActionMessageNotification envelope containing the reserved id and application action.
BroadcastActionMessage<T>Notification envelope containing the reserved id, application action, and data.
ConfigurationCompatibility entry points; use the dedicated service and endpoint extension classes.
ConnectionStorageThread-safe local registry with session and group indexes. Re-add a connection to refresh externally changed membership.
DarkWsBroadcastBackplane message carrying the recipient selector, action name, and optional JSON data.
DarkWsBuilderComposes handlers, authentication, and message-scope services after a single AddDarkWs call.
DarkWsEndpointRouteBuilderExtensionsMaps DarkWS endpoints in the ASP.NET Core request pipeline.
DarkWsExceptionBase for controlled handler errors that supply their own protocol response.
DarkWsMiddlewareConnection lifecycle hooks. Use the supplied context; an injected message context is uninitialized in this scope.
DarkWsOptionsValidated startup settings for serialization, limits, and wire errors; supports the standard .NET Options pipeline.
DarkWsProtocolReserved identifiers in the DarkWS wire protocol.
DarkWsServiceCollectionExtensionsRegisters DarkWS services and validated options.
ErrorMessageError response carrying a stable code and optional typed details.
ErrorMessage<T>Error response carrying a stable code and optional typed details.
ErrorResponseWrites an error code and optional typed details to the client.
ErrorResponse<T>Writes an error code and optional typed details to the client.
ErrorResponseExceptionControlled handler exception translated to an error code and optional typed details.
ErrorResponseException<T>Controlled handler exception translated to an error code and optional typed details.
HandlerAttributeDefines the wire action prefix for a handler class.
HandlerBaseBase for per-message handlers. Context-dependent members are available only during action invocation.
HandlerBase<TSession>Base for per-message handlers. Context-dependent members are available only during action invocation.
InputMessageIncoming request envelope. Id and Action are required; payload nullability follows the action signature.
OkMessageSuccessful response without data, correlated by request id.
ReceivedMessageComplete received message, or a close result with an empty data buffer.
ResponseContextSerializes an action response and sends it to the requesting connection.
ResponseMessage<T>Successful response carrying correlated result data.
SuccessResponseWrites a successful response with optional typed result data.
SuccessResponse<T>Writes a successful response with optional typed result data.
WebSocketConnectionOwns a WebSocket with serialized, bounded writes and coordinated disposal. Send buffers are immutable.
Interfaces
IResponseWrites one action result using a correlation context and cancellation token.
Enums
DarkWsTargetSelects a recipient set for a backplane broadcast.