Class WebSocketBehaviorBinding
Namespace: Cephalon.Behaviors.Http.Bindings
Assembly: Cephalon.Behaviors.Http.dll
Bidirectional WebSocket transport binding (transport ID: http.ws).
Upgrades canonical routes such as GET /ws/v1/cart/get to a full-duplex WebSocket
connection.
Each received JSON text frame is dispatched to the behavior and the result
is sent back as a JSON text frame. The connection is closed gracefully on
client close or cancellation.
public sealed class WebSocketBehaviorBinding : IHttpBehaviorBindingInheritance
Section titled “Inheritance”object ← WebSocketBehaviorBinding
Implements
Section titled “Implements”Inherited Members
Section titled “Inherited Members”object.Equals(object?), object.Equals(object?, object?), object.GetHashCode(), object.GetType(), object.ReferenceEquals(object?, object?), object.ToString()
Remarks
Section titled “Remarks”Canonical routes are derived from the shared ApiRoutes:Prefixes:Ws) and the resolved
default behavior document name.
Constructors
Section titled “Constructors”WebSocketBehaviorBinding(IConfiguration?)
Section titled “ WebSocketBehaviorBinding(IConfiguration?)”Initializes a new
public WebSocketBehaviorBinding(IConfiguration? configuration = null)Parameters
Section titled “Parameters”configuration IConfiguration?
Optional configuration used to resolve canonical behavior transport routes.
When omitted, the binding falls back to the default /ws/v1 route policy.
Properties
Section titled “Properties”TransportId
Section titled “ TransportId”Gets the canonical transport identifier, e.g. http.jsonrpc.
public string TransportId { get; }Property Value
Section titled “Property Value”Methods
Section titled “Methods”MapAsync(WebApplication, BehaviorTopologyDescriptor, BehaviorDispatcher)
Section titled “ MapAsync(WebApplication, BehaviorTopologyDescriptor, BehaviorDispatcher)”Maps the behavior’s routes/endpoints onto the
public Task MapAsync(WebApplication app, BehaviorTopologyDescriptor descriptor, BehaviorDispatcher dispatcher)Parameters
Section titled “Parameters”app WebApplication
The web application to register routes on.
descriptor BehaviorTopologyDescriptor
The behavior topology descriptor.
dispatcher BehaviorDispatcher
The behavior dispatcher to invoke.
Returns
Section titled “Returns”A task that completes when all routes are mapped.