Class SIPServerUserAgent

Implementation of a SIP Server User Agent that can be used to receive SIP calls.

Inheritance
System.Object
SIPServerUserAgent
SIPB2BUserAgent
Implements
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: SIPSorcery.SIP.App
Assembly: SIPSorcery.dll
Syntax
public class SIPServerUserAgent : ISIPServerUserAgent

Constructors

| Improve this Doc View Source

SIPServerUserAgent(SIPTransport, SIPEndPoint, UASInviteTransaction, ISIPAccount)

Declaration
public SIPServerUserAgent(SIPTransport sipTransport, SIPEndPoint outboundProxy, UASInviteTransaction uasTransaction, ISIPAccount sipAccount)
Parameters
Type Name Description
SIPTransport sipTransport
SIPEndPoint outboundProxy
UASInviteTransaction uasTransaction
ISIPAccount sipAccount

Fields

| Improve this Doc View Source

m_isAuthenticated

Declaration
protected bool m_isAuthenticated
Field Value
Type Description
System.Boolean
| Improve this Doc View Source

m_isCancelled

Declaration
protected bool m_isCancelled
Field Value
Type Description
System.Boolean
| Improve this Doc View Source

m_isHungup

Declaration
protected bool m_isHungup
Field Value
Type Description
System.Boolean
| Improve this Doc View Source

m_outboundProxy

Declaration
protected SIPEndPoint m_outboundProxy
Field Value
Type Description
SIPEndPoint
| Improve this Doc View Source

m_sipAccount

Declaration
protected ISIPAccount m_sipAccount
Field Value
Type Description
ISIPAccount
| Improve this Doc View Source

m_sipTransport

Declaration
protected SIPTransport m_sipTransport
Field Value
Type Description
SIPTransport
| Improve this Doc View Source

m_transferMode

Declaration
protected SIPDialogueTransferModesEnum m_transferMode
Field Value
Type Description
SIPDialogueTransferModesEnum
| Improve this Doc View Source

m_uasTransaction

Declaration
protected UASInviteTransaction m_uasTransaction
Field Value
Type Description
UASInviteTransaction

Properties

| Improve this Doc View Source

CallDestination

Declaration
public string CallDestination { get; }
Property Value
Type Description
System.String
| Improve this Doc View Source

CallDirection

Declaration
public SIPCallDirection CallDirection { get; }
Property Value
Type Description
SIPCallDirection
| Improve this Doc View Source

CallRequest

Declaration
public SIPRequest CallRequest { get; }
Property Value
Type Description
SIPRequest
| Improve this Doc View Source

ClientTransaction

Declaration
public UASInviteTransaction ClientTransaction { get; }
Property Value
Type Description
UASInviteTransaction
| Improve this Doc View Source

IsAuthenticated

Declaration
public bool IsAuthenticated { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

IsB2B

Declaration
public bool IsB2B { get; protected set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

IsCancelled

Declaration
public bool IsCancelled { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

IsHangingUp

Declaration
public bool IsHangingUp { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

IsHungup

Declaration
public bool IsHungup { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

IsInvite

Declaration
public bool IsInvite { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

IsUASAnswered

Declaration
public bool IsUASAnswered { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

OfferSDP

The Session Description Protocol offer from the remote call party.

Declaration
public SDP OfferSDP { get; }
Property Value
Type Description
SDP
| Improve this Doc View Source

SIPAccount

Declaration
public ISIPAccount SIPAccount { get; set; }
Property Value
Type Description
ISIPAccount
| Improve this Doc View Source

SIPDialogue

The SIP dialog that's created if we're able to successfully answer the call request.

Declaration
public SIPDialogue SIPDialogue { get; }
Property Value
Type Description
SIPDialogue

Methods

| Improve this Doc View Source

Answer(String, String, SIPDialogueTransferModesEnum)

Declaration
public SIPDialogue Answer(string contentType, string body, SIPDialogueTransferModesEnum transferMode)
Parameters
Type Name Description
System.String contentType
System.String body
SIPDialogueTransferModesEnum transferMode
Returns
Type Description
SIPDialogue
| Improve this Doc View Source

Answer(String, String, SIPDialogueTransferModesEnum, String[])

Declaration
public SIPDialogue Answer(string contentType, string body, SIPDialogueTransferModesEnum transferMode, string[] customHeaders)
Parameters
Type Name Description
System.String contentType
System.String body
SIPDialogueTransferModesEnum transferMode
System.String[] customHeaders
Returns
Type Description
SIPDialogue
| Improve this Doc View Source

Answer(String, String, String, SIPDialogueTransferModesEnum)

Declaration
public SIPDialogue Answer(string contentType, string body, string toTag, SIPDialogueTransferModesEnum transferMode)
Parameters
Type Name Description
System.String contentType
System.String body
System.String toTag
SIPDialogueTransferModesEnum transferMode
Returns
Type Description
SIPDialogue
| Improve this Doc View Source

Answer(String, String, String, SIPDialogueTransferModesEnum, String[])

Declaration
public SIPDialogue Answer(string contentType, string body, string toTag, SIPDialogueTransferModesEnum transferMode, string[] customHeaders)
Parameters
Type Name Description
System.String contentType
System.String body
System.String toTag
SIPDialogueTransferModesEnum transferMode
System.String[] customHeaders
Returns
Type Description
SIPDialogue
| Improve this Doc View Source

AnswerNonInvite(SIPResponseStatusCodesEnum, String, String[], String, String)

Declaration
public void AnswerNonInvite(SIPResponseStatusCodesEnum answerStatus, string reasonPhrase, string[] customHeaders, string contentType, string body)
Parameters
Type Name Description
SIPResponseStatusCodesEnum answerStatus
System.String reasonPhrase
System.String[] customHeaders
System.String contentType
System.String body
| Improve this Doc View Source

AuthenticateCall()

Declaration
public bool AuthenticateCall()
Returns
Type Description
System.Boolean
| Improve this Doc View Source

Hangup(Boolean)

Used to hangup the call or indicate that the client hungup.

Declaration
public void Hangup(bool clientHungup)
Parameters
Type Name Description
System.Boolean clientHungup

True if the BYE request was received from the client. False if the hangup needs to originate from this agent.
| Improve this Doc View Source

NoCDR()

Declaration
public void NoCDR()
| Improve this Doc View Source

Progress(SIPResponseStatusCodesEnum, String, String[], String, String)

Declaration
public void Progress(SIPResponseStatusCodesEnum progressStatus, string reasonPhrase, string[] customHeaders, string progressContentType, string progressBody)
Parameters
Type Name Description
SIPResponseStatusCodesEnum progressStatus
System.String reasonPhrase
System.String[] customHeaders
System.String progressContentType
System.String progressBody
| Improve this Doc View Source

Redirect(SIPResponseStatusCodesEnum, SIPURI)

Declaration
public void Redirect(SIPResponseStatusCodesEnum redirectCode, SIPURI redirectURI)
Parameters
Type Name Description
SIPResponseStatusCodesEnum redirectCode
SIPURI redirectURI
| Improve this Doc View Source

Redirect(SIPResponseStatusCodesEnum, SIPURI, String[])

Declaration
public void Redirect(SIPResponseStatusCodesEnum redirectCode, SIPURI redirectURI, string[] customHeaders)
Parameters
Type Name Description
SIPResponseStatusCodesEnum redirectCode
SIPURI redirectURI
System.String[] customHeaders
| Improve this Doc View Source

Reject(SIPResponseStatusCodesEnum, String)

Declaration
public void Reject(SIPResponseStatusCodesEnum failureStatus, string reasonPhrase)
Parameters
Type Name Description
SIPResponseStatusCodesEnum failureStatus
System.String reasonPhrase
| Improve this Doc View Source

Reject(SIPResponseStatusCodesEnum, String, String[])

Declaration
public void Reject(SIPResponseStatusCodesEnum failureStatus, string reasonPhrase, string[] customHeaders)
Parameters
Type Name Description
SIPResponseStatusCodesEnum failureStatus
System.String reasonPhrase
System.String[] customHeaders
| Improve this Doc View Source

SendNonInviteRequest(SIPRequest)

Declaration
public Task<SocketError> SendNonInviteRequest(SIPRequest sipRequest)
Parameters
Type Name Description
SIPRequest sipRequest
Returns
Type Description
System.Threading.Tasks.Task<System.Net.Sockets.SocketError>

Events

| Improve this Doc View Source

CallCancelled

The caller cancelled the call request.

Declaration
public event SIPUASCancelDelegate CallCancelled
Event Type
Type Description
SIPUASCancelDelegate
| Improve this Doc View Source

NoRingTimeout

This end of the call timed out providing a ringing response. This situation can occur for SIP servers. They will attempt to forward the call to a SIP account's contacts. If none reply then the will never continue past the trying stage.

Declaration
public event SIPUASDelegate NoRingTimeout
Event Type
Type Description
SIPUASDelegate
| Improve this Doc View Source

OnDialogueCreated

Gets fired when the call successfully negotiates an SDP offer/answer and creates a new dialog. Typically this can occur at the same time as the transaction final response is sent. But in cases where the initial INVITE does not contain an SDP offer the dialog will not be created until the ACK is received.

Declaration
public event Action<SIPDialogue> OnDialogueCreated
Event Type
Type Description
System.Action<SIPDialogue>

Implements

Extension Methods