Class IncomingTestCallManager

Class for managing NG9-1-1 incoming test calls.

To use this class, construct an instance of it and then call the Start() method.

Call the Shutdown() method when the application or the object that is using this class is shutting down.

Inheritance
object
QueuedActionWorkerTask
IncomingTestCallManager
Inherited Members
Namespace: SipLib.TestCalls
Assembly: SipLib.dll
Syntax
public class IncomingTestCallManager : QueuedActionWorkerTask

Constructors

| Edit this page View Source

IncomingTestCallManager(SdpAnswerSettings, IncomingTestCallSettings, string)

Constructor

Declaration
public IncomingTestCallManager(SdpAnswerSettings answerSettings, IncomingTestCallSettings testCallSettings, string userName)
Parameters
Type Name Description
SdpAnswerSettings answerSettings

Settings that determine how to answer the test call request.
IncomingTestCallSettings testCallSettings

Settings that determine how to handle test calls.
string userName

SIP user agent name

Methods

| Edit this page View Source

DoTimedEvents()

Not used.

Declaration
protected override void DoTimedEvents()
Overrides
| Edit this page View Source

IsActiveTestCall(SIPRequest)

Tests to see if a SIP request is for an active test call.

Declaration
public bool IsActiveTestCall(SIPRequest sipRequest)
Parameters
Type Name Description
SIPRequest sipRequest

SIP request that was received
Returns
Type Description
bool

Returns true if the request is for an active test call or false if is not.
| Edit this page View Source

IsNg911TestCall(SIPRequest)

Returns true if the SIP request is an INVITE for an NG9-1-1 test call

Declaration
public static bool IsNg911TestCall(SIPRequest sipRequest)
Parameters
Type Name Description
SIPRequest sipRequest

Incoming SIP Request
Returns
Type Description
bool

Returns true if the INVITE is for a NG9-1-1 test call or false if it is not.
| Edit this page View Source

ProcessTestCallByeRequest(SIPRequest, SIPEndPoint, SipTransport)

Processes a BYE request for a test call. This must be called only if IsActiveTestCall() returns true.

Declaration
public void ProcessTestCallByeRequest(SIPRequest sipRequest, SIPEndPoint remoteEndPoint, SipTransport sipTransport)
Parameters
Type Name Description
SIPRequest sipRequest

The SIP BYE request.
SIPEndPoint remoteEndPoint

Sender of the BYE request.
SipTransport sipTransport

Transport that received the request.
| Edit this page View Source

ProcessTestCallInviteRequest(SIPRequest, SIPEndPoint, SipTransport)

Processes an INVITE request for an NG9-1-1 test call. Call this method only if TestCallUtils.IsNg911TestCall() returns true.

Declaration
public void ProcessTestCallInviteRequest(SIPRequest sipRequest, SIPEndPoint remoteEndPoint, SipTransport sipTransport)
Parameters
Type Name Description
SIPRequest sipRequest

Incoming INVITE request for an NG9-1-1 test call.
SIPEndPoint remoteEndPoint

Sender of the INVITE request
SipTransport sipTransport

SipTransport that the request was received on.
| Edit this page View Source

Shutdown()

This method must be called when the application is shutting down to terminate the worker background task.

Declaration
public override Task Shutdown()
Returns
Type Description
Task

Returns an awaitable Task.
Overrides