ZDK
Public Member Functions | List of all members
ZDK::IMSRPConfig Class Referenceabstract

MSRP (Message Session Relay Protocol) specific account configuration. More...

#include <IMSRPConfig.h>

Inheritance diagram for ZDK::IMSRPConfig:
ZDK::IZHandle

Public Member Functions

virtual bool EnableMSRP () const =0
 Gets the use of MSRP functionality as described in RFC 4975. More...
 
virtual void EnableMSRP (bool value)=0
 Sets the use of MSRP functionality as described in RFC 4975. More...
 
virtual bool EnableMSRPChat () const =0
 Gets the use of MSRP chat functionality for the user. More...
 
virtual void EnableMSRPChat (bool value)=0
 Configures the use of MSRP chat functionality for the user. More...
 
virtual bool EnableMSRPFileTransfer () const =0
 Gets the use of file transfer feature for the user. More...
 
virtual void EnableMSRPFileTransfer (bool value)=0
 Configures file transfer feature for the user. More...
 
virtual bool UseMSRPRelay () const =0
 Gets the use of MSRP relay functionality as described in RFC 4976. More...
 
virtual void UseMSRPRelay (bool value)=0
 Configures the use of MSRP relay functionality as described in RFC 4976. More...
 
virtual ZDK::Shared::String MSRPRelayURL () const =0
 Gets the configured MSRP relay URI. More...
 
virtual void MSRPRelayURL (ZDK::Shared::String value)=0
 Configures the MSRP relay URI. More...
 
virtual ZDK::Shared::String MSRPRelayUserName () const =0
 Gets the configured MSRP relay authentication username for the user. More...
 
virtual void MSRPRelayUserName (ZDK::Shared::String value)=0
 Configures MSRP relay authentication username for the user. More...
 
virtual ZDK::Shared::String MSRPRelayPassword () const =0
 Gets the configures MSRP relay password for the user. More...
 
virtual void MSRPRelayPassword (ZDK::Shared::String value)=0
 Configures MSRP relay password for the user. More...
 
virtual bool IsEqual (ZDK::Shared::MSRPConfig comp) const =0
 Compares the current configuration with the given one. More...
 
- Public Member Functions inherited from ZDK::IZHandle
virtual ZDK::ZDKHandle Handle () const =0
 
virtual operator ZDK::ZDKHandle () const =0
 
virtual void Initialize ()=0
 
virtual void ReleaseReference ()=0
 

Detailed Description

MSRP (Message Session Relay Protocol) specific account configuration.

Member Function Documentation

◆ EnableMSRP() [1/2]

virtual bool ZDK::IMSRPConfig::EnableMSRP ( ) const
pure virtual

Gets the use of MSRP functionality as described in RFC 4975.

Returns
  • 0 - disabled
  • 1 - enabled

◆ EnableMSRP() [2/2]

virtual void ZDK::IMSRPConfig::EnableMSRP ( bool  value)
pure virtual

Sets the use of MSRP functionality as described in RFC 4975.

Parameters
[in]value
  • 0 - disabled
  • 1 - enabled

◆ EnableMSRPChat() [1/2]

virtual bool ZDK::IMSRPConfig::EnableMSRPChat ( ) const
pure virtual

Gets the use of MSRP chat functionality for the user.

MSRP chat is done through the messaging class and API - IMessage and SendMessage()

All messages are sent over SIP SIMPLE while an MSRP session is not active. The ZDK will attempt to establish the session automatically but will also use a graylist in case the remote end does not support MSRP.

Returns
  • 0 - disabled
  • 1 - enabled
See also
IMessage, SendMessage()

◆ EnableMSRPChat() [2/2]

virtual void ZDK::IMSRPConfig::EnableMSRPChat ( bool  value)
pure virtual

Configures the use of MSRP chat functionality for the user.

MSRP chat is done through the messaging class and API - IMessage and SendMessage()

All messages are sent over SIP SIMPLE while an MSRP session is not active. The ZDK will attempt to establish the session automatically but will also use a graylist in case the remote end does not support MSRP.

Parameters
[in]value
  • 0 - disabled
  • 1 - enabled
See also
IMessage, SendMessage()

◆ EnableMSRPFileTransfer() [1/2]

virtual bool ZDK::IMSRPConfig::EnableMSRPFileTransfer ( ) const
pure virtual

Gets the use of file transfer feature for the user.

The default is "disabled".

If the file transfer functionality is not enabled for a user all incoming file transfer will be automatically rejected. InitiateTransfer() will return -1 (L_FAIL) immediately and OnFileTransferRequest() will never arrive.

Returns
  • 0 - disabled
  • 1 - enabled
See also
OnFileTransferRequest(), InitiateTransfer()

◆ EnableMSRPFileTransfer() [2/2]

virtual void ZDK::IMSRPConfig::EnableMSRPFileTransfer ( bool  value)
pure virtual

Configures file transfer feature for the user.

The default is "disabled".

If the file transfer functionality is not enabled for a user all incoming file transfer will be automatically rejected. InitiateTransfer() will return -1 (L_FAIL) immediately and OnFileTransferRequest() will never arrive.

Parameters
[in]value
  • 0 - disabled
  • 1 - enabled
See also
OnFileTransferRequest(), InitiateTransfer()

◆ IsEqual()

virtual bool ZDK::IMSRPConfig::IsEqual ( ZDK::Shared::MSRPConfig  comp) const
pure virtual

Compares the current configuration with the given one.

Parameters
[in]compSIP configuration to be compared
Returns
  • 0 - not equal
  • 1 - equal

◆ MSRPRelayPassword() [1/2]

virtual ZDK::Shared::String ZDK::IMSRPConfig::MSRPRelayPassword ( ) const
pure virtual

Gets the configures MSRP relay password for the user.

Configures the password to be used when authenticating to a MSRP relay.

Unlike the MSRP authentication username the password has NO fallback. Its default is the empty string (a valid password for the authentication algorithm).

The password is treated as nul-terminated string, disregarding encoding. It does not appear verbatim anywhere and is used as a binary string during hash calculation.

Returns
The MSRP relay password
See also
MSRPRelayURL(), MSRPRelayUserName()

◆ MSRPRelayPassword() [2/2]

virtual void ZDK::IMSRPConfig::MSRPRelayPassword ( ZDK::Shared::String  value)
pure virtual

Configures MSRP relay password for the user.

Configures the password to be used when authenticating to a MSRP relay.

Unlike the MSRP authentication username the password has NO fallback. Its default is the empty string (a valid password for the authentication algorithm).

The password is treated as nul-terminated string, disregarding encoding. It does not appear verbatim anywhere and is used as a binary string during hash calculation.

Parameters
[in]valueThe MSRP relay password
See also
MSRPRelayURL(), MSRPRelayUserName()

◆ MSRPRelayURL() [1/2]

virtual ZDK::Shared::String ZDK::IMSRPConfig::MSRPRelayURL ( ) const
pure virtual

Gets the configured MSRP relay URI.

The use of MSRP relay must be enabled through UseMSRPRelay().

Configures the MSRP relay URI to use for MSRP sessions done with the same user and on behalf of contacts linked to the same user.

The URI can be partial (just a hostname or an IP address), can contain a port (host:port or ip:port) and can be a full msrp or msrps URI (msrps://host:port;tcp).

Certain other configuration parameters may override the URI parameters.

Returns
MSRP relay URI
See also
UseMSRPRelay(), MSRPRelayUserName(), MSRPRelayPassword()

◆ MSRPRelayURL() [2/2]

virtual void ZDK::IMSRPConfig::MSRPRelayURL ( ZDK::Shared::String  value)
pure virtual

Configures the MSRP relay URI.

The use of MSRP relay must be enabled through UseMSRPRelay().

Configures the MSRP relay URI to use for MSRP sessions done with the same user and on behalf of contacts linked to the same user.

The URI can be partial (just a hostname or an IP address), can contain a port (host:port or ip:port) and can be a full msrp or msrps URI (msrps://host:port;tcp).

Certain other configuration parameters may override the URI parameters.

Parameters
[in]valueMSRP relay URI
See also
UseMSRPRelay(), MSRPRelayUserName(), MSRPRelayPassword()

◆ MSRPRelayUserName() [1/2]

virtual ZDK::Shared::String ZDK::IMSRPConfig::MSRPRelayUserName ( ) const
pure virtual

Gets the configured MSRP relay authentication username for the user.

Configures the authentication username to be used when authenticating to a MSRP relay. It overrides the default which is to use the SIP authentication username if available, or the SIP username itself as a last resort.

The username is treated as nul-terminated string, UTF-8 (due to the fact that it is sent in the MSRP header).

Returns
The MSRP relay authentication username
See also
MSRPRelayURL(), MSRPRelayPassword()

◆ MSRPRelayUserName() [2/2]

virtual void ZDK::IMSRPConfig::MSRPRelayUserName ( ZDK::Shared::String  value)
pure virtual

Configures MSRP relay authentication username for the user.

Configures the authentication username to be used when authenticating to a MSRP relay. It overrides the default which is to use the SIP authentication username if available, or the SIP username itself as a last resort.

The username is treated as nul-terminated string, UTF-8 (due to the fact that it is sent in the MSRP header).

Parameters
[in]valueThe MSRP relay authentication username
See also
MSRPRelayURL(), MSRPRelayPassword()

◆ UseMSRPRelay() [1/2]

virtual bool ZDK::IMSRPConfig::UseMSRPRelay ( ) const
pure virtual

Gets the use of MSRP relay functionality as described in RFC 4976.

Routes all MSRP requests through the MSRP relay configured with MSRPRelayURL().

MSRP relays are almost always needed for MSRP to work for clients behind NATs.

Returns
  • 0 - disabled
  • 1 - enabled
See also
MSRPRelayURL()

◆ UseMSRPRelay() [2/2]

virtual void ZDK::IMSRPConfig::UseMSRPRelay ( bool  value)
pure virtual

Configures the use of MSRP relay functionality as described in RFC 4976.

Routes all MSRP requests through the MSRP relay configured with MSRPRelayURL().

MSRP relays are almost always needed for MSRP to work for clients behind NATs.

Parameters
[in]value
  • 0 - disabled
  • 1 - enabled
See also
MSRPRelayURL()
The documentation for this class was generated from the following file:
Generated by   doxygen 1.8.13