Class SIPURI

Implements the SIP URI concept from the SIP RFC3261.

Inheritance

System.Object

SIPURI

Inherited Members

System.Object.Equals(System.Object, System.Object)

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

Namespace: SIPSorcery.SIP

Assembly: SIPSorcery.dll

Syntax

[DataContract]
public class SIPURI

Constructors

SIPURI(SIPSchemesEnum, SIPEndPoint)

Declaration

public SIPURI(SIPSchemesEnum scheme, SIPEndPoint sipEndPoint)

Parameters

Type	Name	Description
SIPSchemesEnum	scheme
SIPEndPoint	sipEndPoint

SIPURI(SIPSchemesEnum, IPAddress, Int32)

Declaration

public SIPURI(SIPSchemesEnum scheme, IPAddress address, int port)

Parameters

Type	Name	Description
SIPSchemesEnum	scheme
System.Net.IPAddress	address
System.Int32	port

SIPURI(String, String, String)

Declaration

public SIPURI(string user, string host, string paramsAndHeaders)

Parameters

Type	Name	Description
System.String	user
System.String	host
System.String	paramsAndHeaders

SIPURI(String, String, String, SIPSchemesEnum)

Declaration

public SIPURI(string user, string host, string paramsAndHeaders, SIPSchemesEnum scheme)

Parameters

Type	Name	Description
System.String	user
System.String	host
System.String	paramsAndHeaders
SIPSchemesEnum	scheme

SIPURI(String, String, String, SIPSchemesEnum, SIPProtocolsEnum)

Declaration

public SIPURI(string user, string host, string paramsAndHeaders, SIPSchemesEnum scheme, SIPProtocolsEnum protocol)

Parameters

Type	Name	Description
System.String	user
System.String	host
System.String	paramsAndHeaders
SIPSchemesEnum	scheme
SIPProtocolsEnum	protocol

Fields

HEADER_START_DELIMITER

Declaration

public const char HEADER_START_DELIMITER = '?'

Field Value

Type	Description
System.Char

Headers

Declaration

[DataMember]
public SIPParameters Headers

Field Value

Type	Description
SIPParameters

Host

Declaration

[DataMember]
public string Host

Field Value

Type	Description
System.String

None

Declaration

public static SIPURI None

Field Value

Type	Description
SIPURI

PARAM_TAG_DELIMITER

Declaration

public const char PARAM_TAG_DELIMITER = ';'

Field Value

Type	Description
System.Char

Parameters

Declaration

[DataMember]
public SIPParameters Parameters

Field Value

Type	Description
SIPParameters

Scheme

Declaration

[DataMember]
public SIPSchemesEnum Scheme

Field Value

Type	Description
SIPSchemesEnum

SCHEME_ADDR_SEPARATOR

Declaration

public const char SCHEME_ADDR_SEPARATOR = ':'

Field Value

Type	Description
System.Char

User

Declaration

[DataMember]
public string User

Field Value

Type	Description
System.String

USER_HOST_SEPARATOR

Declaration

public const char USER_HOST_SEPARATOR = '@'

Field Value

Type	Description
System.Char

UserParameters

contains the user part parameters if there are any

Declaration

[DataMember]
public SIPParameters UserParameters

Field Value

Type	Description
SIPParameters

UserWithoutParameters

Contains the User part without parameters in case there are any

Declaration

[DataMember]
public string UserWithoutParameters

Field Value

Type	Description
System.String

Properties

CanonicalAddress

Returns a string that can be used to compare SIP URI addresses.

Declaration

public string CanonicalAddress { get; }

Property Value

Type	Description
System.String

HostAddress

Declaration

public string HostAddress { get; }

Property Value

Type	Description
System.String

HostPort

Declaration

public string HostPort { get; }

Property Value

Type	Description
System.String

MAddr

Declaration

public string MAddr { get; }

Property Value

Type	Description
System.String

MAddrOrHost

Declaration

public string MAddrOrHost { get; }

Property Value

Type	Description
System.String

MAddrOrHostAddress

Declaration

public string MAddrOrHostAddress { get; }

Property Value

Type	Description
System.String

Protocol

The protocol for a SIP URI is dictated by the scheme of the URI and then by the transport parameter and finally by the use of a default protocol. If the URI is a sips one then the protocol must be TLS. After that if there is a transport parameter specified for the URI it dictates the protocol for the URI. Finally if there is no transport parameter for a sip URI then the default UDP transport is used.

Declaration

public SIPProtocolsEnum Protocol { get; set; }

Property Value

Type	Description
SIPProtocolsEnum

UnescapedUser

Declaration

public string UnescapedUser { get; }

Property Value

Type	Description
System.String

Methods

AreEqual(SIPURI, SIPURI)

Declaration

public static bool AreEqual(SIPURI uri1, SIPURI uri2)

Parameters

Type	Name	Description
SIPURI	uri1
SIPURI	uri2

Returns

Type	Description
System.Boolean

CopyOf()

Declaration

public SIPURI CopyOf()

Returns

Type	Description
SIPURI

Equals(Object)

Declaration

public override bool Equals(object obj)

Parameters

Type	Name	Description
System.Object	obj

Returns

Type	Description
System.Boolean

Overrides

System.Object.Equals(System.Object)

GetHashCode()

Declaration

public override int GetHashCode()

Returns

Type	Description
System.Int32

Overrides

System.Object.GetHashCode()

IsDefaultPort()

Indicates whether the SIP URI is using the default port for its protocol. Default ports are 5060 for UDP and TCP, 5061 for TLS, 80 for WS and 443 for WSS.

Declaration

public bool IsDefaultPort()

Returns

Type	Description
System.Boolean	True if the default port is being used, false if not.

Mangle(SIPURI, IPEndPoint)

Checks whether the specified SIP URI Host field contains a private IPv4 address and if so and the received on IP address is different then "mangles" the host to contain the received on IP end point. The purpose of the mangling is to assist in dealing with IPv4 NAT's. If the SIP URI host is IPv6 or a host name no mangling will be done.

Declaration

public static SIPURI Mangle(SIPURI uri, IPEndPoint receivedOn)

Parameters

Type	Name	Description
SIPURI	uri	The SIP URI to mangle.
System.Net.IPEndPoint	receivedOn	The IP end point that the SIP message was received from.

Returns

Type	Description
SIPURI	A new SIP URI if mangling took place. Null if no mangling occurred.

ParseSIPURI(String)

Declaration

public static SIPURI ParseSIPURI(string uri)

Parameters

Type	Name	Description
System.String	uri

Returns

Type	Description
SIPURI

ParseSIPURIRelaxed(String)

Declaration

public static SIPURI ParseSIPURIRelaxed(string partialURI)

Parameters

Type	Name	Description
System.String	partialURI

Returns

Type	Description
SIPURI

ParseUserParameters()

this function checks 'User' for user part paramters and puts them into 'UserParameters' and the part before Parameters into UserNumber The Function is called automatically if user=phone is set.

Declaration

public void ParseUserParameters()

ToAOR()

Returns an address of record for the SIP URI which is a string in the format user@host.

Declaration

public string ToAOR()

Returns

Type	Description
System.String	A string representing the address of record for the URI.

ToParameterlessString()

Returns a string representation of the URI with any parameter and headers omitted except for the transport parameter. The string returned by this function is used amongst other things to match Route headers set by this SIP agent.

Declaration

public string ToParameterlessString()

Returns

Type	Description
System.String	A string representation of the URI with headers and parameters omitted except for the transport parameter if it is required.

ToSIPEndPoint()

Declaration

public SIPEndPoint ToSIPEndPoint()

Returns

Type	Description
SIPEndPoint

ToString()

Declaration

public override string ToString()

Returns

Type	Description
System.String

Overrides

System.Object.ToString()

TryParse(String, out SIPURI)

Declaration

public static bool TryParse(string uriStr, out SIPURI uri)

Parameters

Type	Name	Description
System.String	uriStr
SIPURI	uri

Returns

Type	Description
System.Boolean

Operators

Equality(SIPURI, SIPURI)

Declaration

public static bool operator ==(SIPURI uri1, SIPURI uri2)

Parameters

Type	Name	Description
SIPURI	uri1
SIPURI	uri2

Returns

Type	Description
System.Boolean

Inequality(SIPURI, SIPURI)

Declaration

public static bool operator !=(SIPURI x, SIPURI y)

Parameters

Type	Name	Description
SIPURI	x
SIPURI	y

Returns

Type	Description
System.Boolean

Extension Methods

JSONWriter.ToJson(Object)