Search Results for

    Show / Hide Table of Contents

    Class DataChannel

    A data channel.

    Inheritance
    System.Object
    Serializable
    Dynamic
    DataChannelBase<DataChannel>
    DataChannel
    Implements
    IDataChannel<DataChannel>
    Inherited Members
    DataChannelBase<DataChannel>.Id
    DataChannelBase<DataChannel>.StreamId
    DataChannelBase<DataChannel>.ConnectionId
    DataChannelBase<DataChannel>.Label
    DataChannelBase<DataChannel>.Ordered
    DataChannelBase<DataChannel>.Subprotocol
    DataChannelBase<DataChannel>.IsInternal
    DataChannelBase<DataChannel>.OnReceive
    DataChannelBase<DataChannel>.OnStateChange
    DataChannelBase<DataChannel>.IsTerminating
    DataChannelBase<DataChannel>.IsTerminated
    DataChannelBase<DataChannel>.IsTerminatingOrTerminated
    DataChannelBase<DataChannel>.State
    DataChannelBase<DataChannel>.ProcessStateChange()
    DataChannelBase<DataChannel>.MessagesSent
    DataChannelBase<DataChannel>.MessagesReceived
    DataChannelBase<DataChannel>.BytesSent
    DataChannelBase<DataChannel>.BytesReceived
    DataChannelBase<DataChannel>.RegisterDataSent(Int32)
    DataChannelBase<DataChannel>.RegisterDataReceived(Int32)
    DataChannelBase<DataChannel>.RaiseDataBytes(DataBuffer)
    DataChannelBase<DataChannel>.RaiseDataString(String)
    DataChannelBase<DataChannel>.Info
    Dynamic.DynamicProperties
    Dynamic.GetDynamicValue(String)
    Dynamic.SetDynamicValue(String, Object)
    Dynamic.UnsetDynamicValue(String)
    Serializable.IsDirty
    Namespace: FM.LiveSwitch
    Assembly: FM.LiveSwitch.dll
    Syntax
    public class DataChannel : DataChannelBase<DataChannel>, IDataChannel<DataChannel>

    Constructors

    DataChannel(String)

    Initializes a new instance of the DataChannel class.

    Declaration
    public DataChannel(string label)
    Parameters
    Type Name Description
    System.String label

    The label.

    DataChannel(String, Boolean)

    Initializes a new instance of the DataChannel class.

    Declaration
    public DataChannel(string label, bool ordered)
    Parameters
    Type Name Description
    System.String label

    The label.

    System.Boolean ordered

    if set to true [ordered].

    DataChannel(String, Boolean, String)

    Initializes a new instance of the DataChannel class.

    Declaration
    public DataChannel(string label, bool ordered, string subprotocol)
    Parameters
    Type Name Description
    System.String label

    The label.

    System.Boolean ordered

    Whether messages will be delivered in the order they are sent.

    System.String subprotocol

    The subprotocol.

    Properties

    Instance

    Gets the current instance.

    Declaration
    protected override DataChannel Instance { get; }
    Property Value
    Type Description
    DataChannel
    Overrides
    FM.LiveSwitch.DataChannelBase<FM.LiveSwitch.DataChannel>.Instance

    Methods

    ProcessStateLockChange()

    Processes a state lock change.

    Declaration
    protected override void ProcessStateLockChange()
    Overrides
    FM.LiveSwitch.DataChannelBase<FM.LiveSwitch.DataChannel>.ProcessStateLockChange()

    SendDataBytes(DataBuffer)

    Sends bytes.

    Declaration
    public override Future<object> SendDataBytes(DataBuffer dataBytes)
    Parameters
    Type Name Description
    DataBuffer dataBytes

    The data bytes.

    Returns
    Type Description
    Future<System.Object>
    Overrides
    FM.LiveSwitch.DataChannelBase<FM.LiveSwitch.DataChannel>.SendDataBytes(FM.LiveSwitch.DataBuffer)

    SendDataString(String)

    Sends a string.

    Declaration
    public override Future<object> SendDataString(string dataString)
    Parameters
    Type Name Description
    System.String dataString

    The data string.

    Returns
    Type Description
    Future<System.Object>
    Overrides
    FM.LiveSwitch.DataChannelBase<FM.LiveSwitch.DataChannel>.SendDataString(System.String)

    Implements

    IDataChannel<TDataChannel>
    In This Article
    Back to top Copyright © LiveSwitch Inc. All Rights Reserved. Doc build for LiveSwitch v1.15.0