C# Class SIPSorcery.SoftPhone.SIPClient

Inheritance: IVoIPClient
Show file Open project: sipsorcery/sipsorcery Class Usage Examples

Public Methods

Method Description
Answer ( ) : void

Answers an incoming SIP call.

Answer ( MediaManager mediaManager ) : void

Answers an incoming SIP call.

Call ( MediaManager mediaManager, string destination ) : void

Places an outgoing SIP call.

Call ( string destination ) : void

Places an outgoing SIP call.

Cancel ( ) : void

Cancels an outgoing SIP call that hasn't yet been answered.

Hangup ( ) : void

Hangsup an established SIP call.

Redirect ( string destination ) : void

Redirects an incoming SIP call.

Reject ( ) : void

Rejects an incoming SIP call.

SIPClient ( ) : System
Shutdown ( ) : void

Shutdown the SIP tranpsort layer and any other resources the SIP client is using. Typically called when the application exits.

Private Methods

Method Description
CallAnswered ( ISIPClientUserAgent uac, SIPResponse sipResponse ) : void

An outgoing call was successfully answered.

CallFailed ( ISIPClientUserAgent uac, string errorMessage ) : void

An outgoing call was rejected by the remote SIP UAS on an outgoing call.

CallFinished ( ) : void

Cleans up after a SIP call has completely finished.

CallRinging ( ISIPClientUserAgent uac, SIPResponse sipResponse ) : void

A ringing response has been received from the remote SIP UAS on an outgoing call.

CallTrying ( ISIPClientUserAgent uac, SIPResponse sipResponse ) : void

A trying response has been received from the remote SIP UAS on an outgoing call.

InitialiseSIP ( ) : void

Initialises the SIP transport layer.

SIPTransportRequestReceived ( SIPEndPoint localSIPEndPoint, SIPEndPoint remoteEndPoint, SIPRequest sipRequest ) : void

Handler for processing incoming SIP requests.

UASCallCancelled ( ISIPServerUserAgent uas ) : void

An incoming call was cancelled by the caller.

Method Details

Answer() public method

Answers an incoming SIP call.
public Answer ( ) : void
return void

Answer() public method

Answers an incoming SIP call.
public Answer ( MediaManager mediaManager ) : void
mediaManager MediaManager
return void

Call() public method

Places an outgoing SIP call.
public Call ( MediaManager mediaManager, string destination ) : void
mediaManager MediaManager
destination string The SIP URI to place a call to. The destination can be a full SIP URI in which case the all will /// be placed anonymously directly to that URI. Alternatively it can be just the user portion of a URI in which case it will /// be sent to the configured SIP server.
return void

Call() public method

Places an outgoing SIP call.
public Call ( string destination ) : void
destination string The SIP URI to place a call to. The destination can be a full SIP URI in which case the all will /// be placed anonymously directly to that URI. Alternatively it can be just the user portion of a URI in which case it will /// be sent to the configured SIP server.
return void

Cancel() public method

Cancels an outgoing SIP call that hasn't yet been answered.
public Cancel ( ) : void
return void

Hangup() public method

Hangsup an established SIP call.
public Hangup ( ) : void
return void

Redirect() public method

Redirects an incoming SIP call.
public Redirect ( string destination ) : void
destination string
return void

Reject() public method

Rejects an incoming SIP call.
public Reject ( ) : void
return void

SIPClient() public method

public SIPClient ( ) : System
return System

Shutdown() public method

Shutdown the SIP tranpsort layer and any other resources the SIP client is using. Typically called when the application exits.
public Shutdown ( ) : void
return void