Class SIPTCPChannel

Class for managing a SIP connection using the TCP protocol.

Inheritance
object
SIPChannel
SIPTCPChannel
Inherited Members
Namespace: SipLib.Channels
Assembly: SipLib.dll
Syntax
public class SIPTCPChannel : SIPChannel

Constructors

| Edit this page View Source

SIPTCPChannel(IPEndPoint, string?, AcceptConnectionDelegate?)

Constructs a new SIPTCPChannel and initializes the connection.

Declaration
public SIPTCPChannel(IPEndPoint localIPEndPoint, string? User = null, AcceptConnectionDelegate? acceptConnection = null)
Parameters
Type Name Description
IPEndPoint localIPEndPoint

Local IPEndPoint to listen on.
string User

Specifies the User part of the SIPURI for the local contact URI. This parameter defaults to null.
AcceptConnectionDelegate acceptConnection

User provided callback function that can determine whether or not to accept a network connection based on the client's IPEndPoint and the protocol type. Defaults to null.

Methods

| Edit this page View Source

Close()

Closes the listener socket and closes connections to all clients.

Declaration
public override void Close()
Overrides
| Edit this page View Source

GetConnectionsList()

Gets a dictionary containing the current connections. The returned object must be locked by the caller.

Declaration
protected override Dictionary<string, SIPConnection> GetConnectionsList()
Returns
Type Description
Dictionary<string, SIPConnection>
Overrides
| Edit this page View Source

IsConnectionEstablished(IPEndPoint)

Checks to see if this object is currently connected to a remote endpoint

Declaration
public override bool IsConnectionEstablished(IPEndPoint remoteEndPoint)
Parameters
Type Name Description
IPEndPoint remoteEndPoint
Returns
Type Description
bool

True if currently connected or false if not connected
Overrides
| Edit this page View Source

Send(IPEndPoint, byte[])

Sends a byte array

Declaration
public override void Send(IPEndPoint dstEndPoint, byte[] buffer)
Parameters
Type Name Description
IPEndPoint dstEndPoint

IPEndPoint to send the message to.
byte[] buffer

Message to send.
Overrides
| Edit this page View Source

Send(IPEndPoint, byte[], string?)

Sends a byte array.

Declaration
public override void Send(IPEndPoint dstEndPoint, byte[] buffer, string? serverCertificateName)
Parameters
Type Name Description
IPEndPoint dstEndPoint

IPEndPoint to send the message to.
byte[] buffer

Message to send.
string serverCertificateName

Not used. May be null.
Overrides
| Edit this page View Source

Send(IPEndPoint, string)

Sends a string

Declaration
public override void Send(IPEndPoint destinationEndPoint, string message)
Parameters
Type Name Description
IPEndPoint destinationEndPoint

IPEndPoint to send the message to.
string message

Message to send.
Overrides

Events

| Edit this page View Source

SIPConnectionDisconnected

Fired if the TCP connection gets disconnected

Declaration
public event SipConnectionFailedDelegate? SIPConnectionDisconnected
Event Type
Type Description
SipConnectionFailedDelegate
| Edit this page View Source

SIPConnectionFailed

Fired if the TCP connection request to a remote endpoint failed.

Declaration
public event SipConnectionFailedDelegate? SIPConnectionFailed
Event Type
Type Description
SipConnectionFailedDelegate