Logo FSBarV1_Archived

AdminChannel Type

Live admin channel. One instance owns one UDP socket and one
 receive pump. Dispose to close the socket and stop the pump.

Instance members

Instance member Description

this.Events

Full Usage: this.Events

Returns: IObservable<AdminEventIn>

Observable of inbound engine events. Completes when the channel transitions to Closed.

Returns: IObservable<AdminEventIn>

this.LocalPort

Full Usage: this.LocalPort

Returns: int option

Allocated local port. Valid once State is Bound or later.

Returns: int option

this.Send

Full Usage: this.Send

Parameters:
Returns: Result<unit, string>

Send one outbound command. Returns Ok when the UDP datagram has been written; Error if the socket is closed, unbound, or the engine endpoint is still unknown (no inbound datagram yet).

cmd : AdminCommandOut
Returns: Result<unit, string>

this.State

Full Usage: this.State

Returns: ChannelState

Current socket-level state. Thread-safe snapshot.

Returns: ChannelState

Type something to start searching.