BLOG | DOCUMENTATION | GITHUB

Home --> Documentations --> PJSIP Reference

#include <endpoint.hpp>

Public Member Functions

 TlsInfo ()
 
bool isEmpty () const
 
void fromPj (const pjsip_tls_state_info &info)
 

Data Fields

bool established
 
unsigned protocol
 
pj_ssl_cipher cipher
 
string cipherName
 
SocketAddress localAddr
 
SocketAddress remoteAddr
 
SslCertInfo localCertInfo
 
SslCertInfo remoteCertInfo
 
unsigned verifyStatus
 
StringVector verifyMsgs
 

Detailed Description

TLS transport information.

Constructor & Destructor Documentation

◆ TlsInfo()

pj::TlsInfo::TlsInfo ( )

Constructor.

Member Function Documentation

◆ isEmpty()

bool pj::TlsInfo::isEmpty ( ) const

Check if the info is set with empty values.

Returns
True if the info is empty.

◆ fromPj()

void pj::TlsInfo::fromPj ( const pjsip_tls_state_info info)

Convert from pjsip

Field Documentation

◆ established

bool pj::TlsInfo::established

Describes whether secure socket connection is established, i.e: TLS/SSL handshaking has been done successfully.

◆ protocol

unsigned pj::TlsInfo::protocol

Describes secure socket protocol being used, see pj_ssl_sock_proto. Use bitwise OR operation to combine the protocol type.

◆ cipher

pj_ssl_cipher pj::TlsInfo::cipher

Describes cipher suite being used, this will only be set when connection is established.

◆ cipherName

string pj::TlsInfo::cipherName

Describes cipher name being used, this will only be set when connection is established.

◆ localAddr

SocketAddress pj::TlsInfo::localAddr

Describes local address.

◆ remoteAddr

SocketAddress pj::TlsInfo::remoteAddr

Describes remote address.

◆ localCertInfo

SslCertInfo pj::TlsInfo::localCertInfo

Describes active local certificate info. Use SslCertInfo.isEmpty() to check if the local cert info is available.

◆ remoteCertInfo

SslCertInfo pj::TlsInfo::remoteCertInfo

Describes active remote certificate info. Use SslCertInfo.isEmpty() to check if the remote cert info is available.

◆ verifyStatus

unsigned pj::TlsInfo::verifyStatus

Status of peer certificate verification.

◆ verifyMsgs

StringVector pj::TlsInfo::verifyMsgs

Error messages (if any) of peer certificate verification, based on the field verifyStatus above.


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

 


PJSIP Open Source, high performance, small footprint, and very very portable SIP stack
Copyright (C) 2006-2008 Teluu Inc.