OwrDataChannel

OwrDataChannel

Functions

Properties

guint buffered-amount Read
guint id Read / Write / Construct Only
gchar * label Read / Write / Construct Only
gint max-packet-life-time Read / Write / Construct Only
gint max-retransmits Read / Write / Construct Only
gboolean negotiated Read / Write / Construct Only
gboolean ordered Read / Write / Construct Only
gchar * protocol Read / Write / Construct Only
OwrDataChannelReadyStates ready-state Read

Signals

Object Hierarchy

    GObject
    ╰── OwrDataChannel

Description

Functions

OWR_DATA_CHANNEL_READY_STATE_TYPE

#define OWR_DATA_CHANNEL_READY_STATE_TYPE (owr_data_channel_ready_state_get_type())

owr_data_channel_new ()

OwrDataChannel *
owr_data_channel_new (gboolean ordered,
                      gint max_packet_life_time,
                      gint max_retransmits,
                      const gchar *protocol,
                      gboolean negotiated,
                      guint16 id,
                      const gchar *label);

owr_data_channel_send ()

void
owr_data_channel_send (OwrDataChannel *data_channel,
                       const gchar *data);

owr_data_channel_send_binary ()

void
owr_data_channel_send_binary (OwrDataChannel *data_channel,
                              const guint8 *data,
                              guint16 length);

Parameters

data

.

[array length=length]

owr_data_channel_close ()

void
owr_data_channel_close (OwrDataChannel *data_channel);

Types and Values

Property Details

The “buffered-amount” property

  “buffered-amount”          guint

The amount of buffered outgoing data on this data channel.

Flags: Read

Default value: 0


The “id” property

  “id”                       guint

Channel id. Unless otherwise defined or negotiated, the id are picked based on the DTLS role; client picks even identifiers and server picks odd. However, the application is responsible for avoiding conflicts. In case of conflict, the channel should fail.

Flags: Read / Write / Construct Only

Allowed values: <= 65535

Default value: 0


The “label” property

  “label”                    gchar *

The label of the channel.

Flags: Read / Write / Construct Only

Default value: ""


The “max-packet-life-time” property

  “max-packet-life-time”     gint

The maximum time to try to retransmit a packet.

Flags: Read / Write / Construct Only

Allowed values: [-1,65535]

Default value: -1


The “max-retransmits” property

  “max-retransmits”          gint

The maximum number of retransmits for a packet.

Flags: Read / Write / Construct Only

Allowed values: [-1,65535]

Default value: -1


The “negotiated” property

  “negotiated”               gboolean

Datachannel already negotiated.

Flags: Read / Write / Construct Only

Default value: FALSE


The “ordered” property

  “ordered”                  gboolean

Send data ordered.

Flags: Read / Write / Construct Only

Default value: TRUE


The “protocol” property

  “protocol”                 gchar *

Sub-protocol used for this channel.

Flags: Read / Write / Construct Only

Default value: ""


The “ready-state” property

  “ready-state”              OwrDataChannelReadyStates

The ready state of the data channel.

Flags: Read

Default value: Ready State connecting

Signal Details

The “on-binary-data” signal

void
user_function (OwrDataChannel *data_channel,
               gpointer        binary_data,
               guint           length,
               gpointer        user_data)

Parameters

binary_data

.

[array length=length][element-type guint8]

user_data

user data set when the signal handler was connected.

 

Flags: Run First


The “on-data” signal

void
user_function (OwrDataChannel *owrdatachannel,
               gchar          *arg1,
               gpointer        user_data)

Flags: Run First