navigation

Channels

Namespace: Saturn
Parent: Saturn
Declared Types
Type Description
ChannelPath

Url (relative to root application url) on which channel is hosted. Type alias for string

ClientInfo

Type representing information about client that has executed some channel action It's passed as an argument in channel actions (join, handle, terminate)

IChannel

Interface of the internal representation of the channel. Shouldn't be used manually, you get its instance from the channel Computation Expression

ISocketHub

Interface representing server side Socket Hub, giving you ability to brodcast messages (either to particular socket or to all sockets). You can get instance of it with ctx.GetService<Saturn.Channels.ISocketHub>() from any place that has access to HttpContext instance (controller actions, channel actions, normal HttpHandler)

JoinResult

Type representing result of join action. It can be either succesful (Ok) or you can reject client connection (Rejected)

Message<'a>

Types representing channels message. It always includes topic, reference id of the message (random GUID), and payload object.

SocketHub

A type that wraps access to connected websockets by endpoint

SocketId

Socket Id. Type alias for Guid

SocketMiddleware
Topic

Topic of the channel. Type alias for string