zrtp_stream_info_t Struct Reference
[Types and DefinitionsZRTP Connections]

zrtp stream information structure

libzrtp, since v0.80 takes data incapsulating approach and hides all private date inside zrtp_stream_t structure. Developers shouldn't access them directly. zrtp_stream_get() should be used instead to fill zrtp_stream_info_t structure. zrtp_stream_info_t contains all needed information in safe and easy to use form. More...

#include <zrtp.h>


Data Fields

zrtp_id_t id
 Stream unique identifier for debug purposes.
zrtp_session_t * session
 Pointer to the parent zrtp session.
zrtp_stream_mode_t mode
 Stream mode. Defines libzrtp behavior related to specified contexts.
zrtp_mitm_mode_t mitm_mode
 Defines ZRTP Trusted mitm mode for the current session.
zrtp_state_t state
 Reflects current state of ZRTP protocol.
zrtp_protocol_error_t last_error
 Last protocol error code.
uint8_t peer_passive
 Remote passive flag.
uint8_t res_allowclear
 Allowclear flag.
uint8_t peer_disclose
 Peer disclose bit flag.
uint8_t peer_mitm
 Defines that remote party is ZRTP MiTM endpoint.


Detailed Description

zrtp stream information structure

libzrtp, since v0.80 takes data incapsulating approach and hides all private date inside zrtp_stream_t structure. Developers shouldn't access them directly. zrtp_stream_get() should be used instead to fill zrtp_stream_info_t structure. zrtp_stream_info_t contains all needed information in safe and easy to use form.


Field Documentation

Last protocol error code.

Available for reading in ERROR state on zrtp_security_event_t::ZRTP_EVENT_PROTOCOL_ERROR.

uint8_t peer_disclose

Peer disclose bit flag.

Indicates the ability of the remote side to disclose its session key. Specifies that the remote side allows call monitoring. If this flag is set, the end user must be informed. It can be read in the SECURE state.

uint8_t peer_mitm

Defines that remote party is ZRTP MiTM endpoint.

Enabled by (Asterisk PBX, UMLab SIP Firewall or etc.) Available for reading in CLEAR state ande later.

uint8_t peer_passive

Remote passive flag.

This flag shows when remote side is "passive" (has license mode PASSIVE) available in CLEAR state and later.

uint8_t res_allowclear

Allowclear flag.

Current value of "allowclear" option exchanged during ZRTP negotiation. Available in SECURE state.


The documentation for this struct was generated from the following file:

Generated on Wed Dec 9 17:31:06 2009 for libzrtp  zfone