OwrSession

OwrSession — OwrSession

Functions

void owr_session_add_remote_candidate ()
void owr_session_force_remote_candidate ()

Properties

gchar * dtls-certificate Read / Write
gboolean dtls-client-mode Read / Write / Construct Only
gchar * dtls-key Read / Write
gchar * dtls-peer-certificate Read
OwrIceStates ice-connection-state Read

Signals

void on-candidate-gathering-done Run First
void on-new-candidate Run First

Types and Values

struct OwrSessionClass

Object Hierarchy

    GObject
    ╰── OwrSession
        ├── OwrDataSession
        ╰── OwrMediaSession

Description

OwrSession - Represents a connection used for a session of either media or data.

Functions

owr_session_add_remote_candidate ()

void
owr_session_add_remote_candidate (OwrSession *session,
                                  OwrCandidate *candidate);

Adds a remote candidate for this session.

Parameters

session

the session on which the candidate will be added.

  

candidate

the candidate to add.

[transfer none]

owr_session_force_remote_candidate ()

void
owr_session_force_remote_candidate (OwrSession *session,
                                    OwrCandidate *candidate);

Forces the transport agent to use the given candidate. Calling this function will disable all further ICE processing. Keep-alives will continue to be sent.

Parameters

session

The session on which the candidate will be forced.

  

candidate

the candidate to forcibly set.

[transfer none]

Types and Values

struct OwrSessionClass

struct OwrSessionClass {
    GObjectClass parent_class;

    /* signals */
    void (*on_new_candidate)(OwrSession *session, OwrCandidate *candidate);
    void (*on_candidate_gathering_done)(OwrSession *session);
};

The session class.

Members

GObjectClass parent_class;

the GObject parent

  

on_new_candidate ()

    

on_candidate_gathering_done ()

    

Property Details

The “dtls-certificate” property

  “dtls-certificate”         gchar *

The X509 certificate to be used by DTLS (in PEM format). Set to NULL or empty string to disable DTLS.

Flags: Read / Write

Default value: "(auto)"

The “dtls-client-mode” property

  “dtls-client-mode”         gboolean

TRUE if the DTLS connection should be setup using client role.

Flags: Read / Write / Construct Only

Default value: FALSE

The “dtls-key” property

  “dtls-key”                 gchar *

The RSA private key to be used by DTLS (in PEM format).

Flags: Read / Write

Default value: "(auto)"

The “dtls-peer-certificate” property

  “dtls-peer-certificate”    gchar *

The X509 certificate of the remote peer, used by DTLS (in PEM format).

Flags: Read

Default value: NULL

The “ice-connection-state” property

  “ice-connection-state”     OwrIceStates

The state of the ICE connection.

Flags: Read

Default value: ICE state disconnected

Signal Details

The “on-candidate-gathering-done” signal

void
user_function (OwrSession *session,
               gpointer    user_data)

Notify that all candidates have been gathered for a OwrSession

Parameters

session

the object which received the signal

  

user_data

user data set when the signal handler was connected.

  

Flags: Run First

The “on-new-candidate” signal

void
user_function (OwrSession   *session,
               OwrCandidate *candidate,
               gpointer      user_data)

Notify of a new gathered candidate for a OwrSession.

Parameters

session

the object which received the signal

  

candidate

the candidate gathered

  

user_data

user data set when the signal handler was connected.

  

Flags: Run First

Generated by GTK-Doc V1.21