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

#include <MSRPConfig.h>

Inheritance diagram for ZDK_NET::MSRPConfig:

Public Member Functions
	MSRPConfig (ZDK::Shared::MSRPConfig src)

bool	IsEqual (ZDK_NET::MSRPConfig^ comp)
	Compares the current configuration with the given one. More...

virtual long long	Handle () override

virtual void	Initialize () override

virtual void	ReleaseReference () override

Public Attributes
ZDK::IMSRPConfig *	cppRef = nullptr

Properties
bool	EnableMSRP `[get, set]`
	Sets the use of MSRP functionality as described in RFC 4975. More...

bool	EnableMSRPChat `[get, set]`
	Configures the use of MSRP chat functionality for the user. More...

bool	EnableMSRPFileTransfer `[get, set]`
	Configures file transfer feature for the user. More...

bool	UseMSRPRelay `[get, set]`
	Configures the use of MSRP relay functionality as described in RFC 4976. More...

System::String^	MSRPRelayURL `[get, set]`
	Configures the MSRP relay URI. More...

System::String^	MSRPRelayUserName `[get, set]`
	Configures MSRP relay authentication username for the user. More...

System::String^	MSRPRelayPassword `[get, set]`
	Configures MSRP relay password for the user. More...

int	MSRPTcpPort `[get, set]`
	Configures the main MSRP TCP port. More...

Detailed Description

MSRP (Message Session Relay Protocol) specific account configuration.

Member Function Documentation

◆ IsEqual()

bool ZDK_NET::MSRPConfig::IsEqual ( ZDK_NET::MSRPConfig^ comp )

Compares the current configuration with the given one.

Parameters

[in] comp SIP configuration to be compared

Returns

0 - not equal
1 - equal

Property Documentation

◆ EnableMSRP

bool ZDK_NET::MSRPConfig::EnableMSRP

getset

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

Parameters

[in]

value

0 - disabled
1 - enabled

◆ EnableMSRPChat

bool ZDK_NET::MSRPConfig::EnableMSRPChat

getset

Configures the use of MSRP chat functionality for the user.

MSRP chat is done through the messaging class and API - Message 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: Message, SendMessage()

◆ EnableMSRPFileTransfer

bool ZDK_NET::MSRPConfig::EnableMSRPFileTransfer

getset

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()

◆ MSRPRelayPassword

System:: String^ ZDK_NET::MSRPConfig::MSRPRelayPassword

getset

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] value The MSRP relay password

See also: MSRPRelayURL(), MSRPRelayUserName()

◆ MSRPRelayURL

System:: String^ ZDK_NET::MSRPConfig::MSRPRelayURL

getset

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:

Certain other configuration parameters may override the URI parameters.

Parameters

[in] value MSRP relay URI

See also: UseMSRPRelay(), MSRPRelayUserName(), MSRPRelayPassword()

◆ MSRPRelayUserName

System:: String^ ZDK_NET::MSRPConfig::MSRPRelayUserName

getset

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] value The MSRP relay authentication username

See also: MSRPRelayURL(), MSRPRelayPassword()

◆ MSRPTcpPort

int ZDK_NET::MSRPConfig::MSRPTcpPort

getset

Configures the main MSRP TCP port.

Configures the main TCP port for MSRP. This port is used to listen on all local interfaces for incoming MSRP connections.

The default MSRP port is 2855 as described in RFC4975.

Parameters

[in] value The MSRP TCP port

◆ UseMSRPRelay

bool ZDK_NET::MSRPConfig::UseMSRPRelay

getset

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:

Configurations/MSRPConfig.h

Public Member Functions

Public Attributes

Properties

Detailed Description

Member Function Documentation

◆ IsEqual()

Property Documentation

◆ EnableMSRP

◆ EnableMSRPChat

◆ EnableMSRPFileTransfer

◆ MSRPRelayPassword

◆ MSRPRelayURL

◆ MSRPRelayUserName

◆ MSRPTcpPort

◆ UseMSRPRelay