Search Results for

    Show / Hide Table of Contents

    Interface IDataChannel<TDataChannel>

    Data channel interface.

    Namespace: FM.LiveSwitch
    Assembly: FM.LiveSwitch.dll
    Syntax
    public interface IDataChannel<TDataChannel>
    Type Parameters
    Name Description
    TDataChannel

    Properties

    Id

    Gets the data channel identifier.

    Declaration
    string Id { get; }
    Property Value
    Type Description
    System.String

    Info

    Gets the data channel info.

    Declaration
    DataChannelInfo Info { get; }
    Property Value
    Type Description
    DataChannelInfo

    IsInternal

    Gets a value indicating if this is an internal data channel.

    Declaration
    bool IsInternal { get; }
    Property Value
    Type Description
    System.Boolean

    Label

    Gets the label.

    Declaration
    string Label { get; }
    Property Value
    Type Description
    System.String

    OnReceive

    Gets or sets the callback to execute when a message is received.

    Declaration
    Action1<DataChannelReceiveArgs> OnReceive { get; set; }
    Property Value
    Type Description
    Action1<DataChannelReceiveArgs>

    Ordered

    Gets a value indicating whether messages will be delivered in the order they are sent.

    Declaration
    bool Ordered { get; }
    Property Value
    Type Description
    System.Boolean

    State

    Gets the state.

    Declaration
    DataChannelState State { get; }
    Property Value
    Type Description
    DataChannelState

    Subprotocol

    Gets the subprotocol.

    Declaration
    string Subprotocol { get; }
    Property Value
    Type Description
    System.String

    Methods

    SendDataBytes(DataBuffer)

    Sends a byte array.

    Declaration
    Future<object> SendDataBytes(DataBuffer dataBytes)
    Parameters
    Type Name Description
    DataBuffer dataBytes
    Returns
    Type Description
    Future<System.Object>

    SendDataString(String)

    Sends a string.

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

    Events

    OnStateChange

    Raised when the state changes.

    Declaration
    event Action1<TDataChannel> OnStateChange
    Event Type
    Type Description
    Action1<TDataChannel>
    In This Article
    Back to top Copyright © LiveSwitch Inc. All Rights Reserved. Doc build for LiveSwitch v1.15.0