#include <ice.h>
Data Fields | |
| struct _IceCheckList * | streams [8] |
| MSStunAuthRequestedCb | stun_auth_requested_cb |
| void * | stun_auth_requested_userdata |
| char * | local_ufrag |
| char * | local_pwd |
| char * | remote_ufrag |
| char * | remote_pwd |
| IceRole | role |
| IceSessionState | state |
| uint64_t | tie_breaker |
| int32_t | ta |
| int | event_value |
| MSTimeSpec | event_time |
| struct sockaddr_storage | ss |
| socklen_t | ss_len |
| MSTimeSpec | gathering_start_ts |
| MSTimeSpec | gathering_end_ts |
| MSTimeSpec | connectivity_checks_start_ts |
| IceCandidateType | default_types [ICT_CandidateTypeMax] |
| bool_t | check_message_integrity |
| bool_t | send_event |
| uint8_t | max_connectivity_checks |
| uint8_t | keepalive_timeout |
| bool_t | forced_relay |
| bool_t | turn_enabled |
| bool_t | short_turn_refresh |
| bool_t | default_candidates_prefer_ipv6 |
Detailed Description
Structure representing an ICE session.
Field Documentation
◆ event_time
| MSTimeSpec _IceSession::event_time |
Value of the event to send Time when an event must be sent
◆ forced_relay
| bool_t _IceSession::forced_relay |
Force use of relay by modifying the local and reflexive candidates
◆ keepalive_timeout
| uint8_t _IceSession::keepalive_timeout |
Configuration parameter to define the timeout between each keepalive packets (default is 15s)
◆ local_pwd
| char* _IceSession::local_pwd |
Local password for the session (assigned during the session creation)
◆ local_ufrag
| char* _IceSession::local_ufrag |
Local username fragment for the session (assigned during the session creation)
◆ max_connectivity_checks
| uint8_t _IceSession::max_connectivity_checks |
Configuration parameter to limit the number of connectivity checks performed by the agent (default is 100)
◆ remote_pwd
| char* _IceSession::remote_pwd |
Remote password for the session (provided via SDP by the peer)
◆ remote_ufrag
| char* _IceSession::remote_ufrag |
Remote username fragment for the session (provided via SDP by the peer)
◆ role
| IceRole _IceSession::role |
Role played by the agent for this session
◆ send_event
| bool_t _IceSession::send_event |
Boolean value telling whether an event must be sent or not
◆ short_turn_refresh
| bool_t _IceSession::short_turn_refresh |
Short TURN refresh for tests
◆ ss
| struct sockaddr_storage _IceSession::ss |
STUN server address to use for the candidates gathering process
◆ ss_len
| socklen_t _IceSession::ss_len |
Length of the STUN server address to use for the candidates gathering process
◆ state
| IceSessionState _IceSession::state |
State of the session
◆ streams
| struct _IceCheckList* _IceSession::streams[8] |
Table of IceChecklist structure pointers. Each element represents a media stream
◆ stun_auth_requested_cb
| MSStunAuthRequestedCb _IceSession::stun_auth_requested_cb |
Callback called when authentication is requested
◆ stun_auth_requested_userdata
| void* _IceSession::stun_auth_requested_userdata |
Userdata to pass to the STUN authentication requested callback
◆ ta
| int32_t _IceSession::ta |
Duration of timer for sending connectivity checks in ms
◆ tie_breaker
| uint64_t _IceSession::tie_breaker |
Random number used to resolve role conflicts (see paragraph 5.2 of the RFC 5245)
◆ turn_enabled
| bool_t _IceSession::turn_enabled |
TURN protocol enabled
The documentation for this struct was generated from the following file:
