Class SIPClientUserAgent

Inheritance
System.Object
SIPClientUserAgent
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 SIPClientUserAgent : ISIPClientUserAgent

Constructors

| Improve this Doc View Source

SIPClientUserAgent(SIPTransport)

Creates a new SIP user agent client to act as the client on a SIP INVITE transaction.

Declaration
public SIPClientUserAgent(SIPTransport sipTransport)
Parameters
Type Name Description
SIPTransport sipTransport

The SIP transport this user agent will use for sending and receiving SIP messages.
| Improve this Doc View Source

SIPClientUserAgent(SIPTransport, SIPEndPoint)

Declaration
public SIPClientUserAgent(SIPTransport sipTransport, SIPEndPoint outboundProxy)
Parameters
Type Name Description
SIPTransport sipTransport
SIPEndPoint outboundProxy

Fields

| Improve this Doc View Source

AdjustInvite

Declaration
public Func<SIPRequest, SIPRequest> AdjustInvite
Field Value
Type Description
System.Func<SIPRequest, SIPRequest>

Properties

| Improve this Doc View Source

CallDescriptor

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

IsHangingUp

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

IsUACAnswered

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

PrackSupported

Determines whether the agent will operate with support for reliable provisional responses as per RFC3262. If support is not desired it should be set to false before the initial INVITE request is sent.

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

ServerTransaction

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

SIPDialogue

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

Methods

| Improve this Doc View Source

AckAnswer(SIPResponse, String, String)

Sends AckAnswer response.

Declaration
public void AckAnswer(SIPResponse sipResponse, string content, string contentType)
Parameters
Type Name Description
SIPResponse sipResponse

SIPResponse to acknowledge
System.String content

The optional content body for the ACK request.
System.String contentType

The optional content type.
| Improve this Doc View Source

Call(SIPCallDescriptor)

Declaration
public SIPRequest Call(SIPCallDescriptor sipCallDescriptor)
Parameters
Type Name Description
SIPCallDescriptor sipCallDescriptor
Returns
Type Description
SIPRequest
| Improve this Doc View Source

Call(SIPCallDescriptor, SIPEndPoint)

Initiates the call to the remote user agent server.

Declaration
public SIPRequest Call(SIPCallDescriptor sipCallDescriptor, SIPEndPoint serverEndPoint)
Parameters
Type Name Description
SIPCallDescriptor sipCallDescriptor

The descriptor for the call that describes how to reach the user agent server and other properties.
SIPEndPoint serverEndPoint

Optional. If the server end point for the call is known or has been resolved in advance. If not set the SIP transport layer will attempt to resolve the destination at sending time.
Returns
Type Description
SIPRequest
| Improve this Doc View Source

Cancel()

Cancels an in progress call. This method should be called prior to the remote user agent server answering the call.

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

GetCallDestination(SIPCallDescriptor)

Gets the destination of the remote SIP end point for this call.

Declaration
public async Task<SIPEndPoint> GetCallDestination(SIPCallDescriptor sipCallDescriptor)
Parameters
Type Name Description
SIPCallDescriptor sipCallDescriptor

The call descriptor containing the settings to use to place the call.
Returns
Type Description
System.Threading.Tasks.Task<SIPEndPoint>

The server end point for the call.
| Improve this Doc View Source

Hangup()

Declaration
public void Hangup()
| 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

CallAnswered

Declaration
public event SIPCallResponseDelegate CallAnswered
Event Type
Type Description
SIPCallResponseDelegate
| Improve this Doc View Source

CallFailed

Declaration
public event SIPCallFailedDelegate CallFailed
Event Type
Type Description
SIPCallFailedDelegate
| Improve this Doc View Source

CallRinging

Declaration
public event SIPCallResponseDelegate CallRinging
Event Type
Type Description
SIPCallResponseDelegate
| Improve this Doc View Source

CallTrying

Declaration
public event SIPCallResponseDelegate CallTrying
Event Type
Type Description
SIPCallResponseDelegate

Implements

Extension Methods