|
Class |
Description |
|
ApplicationConfigChangedEventArgs
|
Arguments passed to the event
handler when application settings change
|
|
ApplicationConfigHelper
|
Class which wraps
ServiceConsumer to provide information about ServerApplication
configuration.
|
|
ApplicationConfigHelperException
|
Exception to wrap internal
exceptions.
|
|
ApplicationConfiguration
|
Contains configuration
information for a server application.
|
|
ApplicationManifest
|
The application manifest
class.
|
|
AppViaStamp
|
This class represents an
App-Via Stamp and is derived from the
System.Objectclass.
|
|
AppViaStampCollection
|
The
AppViaStampCollectionclass represents a
read-only collection of AppViaStamps. This class implements the
IEnumerableand
ICollectioninterfaces and is derived
from the
System.Objectclass.
|
|
AuthorizedHostOperationCompletedEventArgs
|
Represents the
AuthorizedHostOperationCompleted event handler arguments.
|
|
BranchCollection
|
The
BranchCollectionclass represents an
unordered collection of client transactions (branches) that are
associated with a server transaction. Each client transaction is
represented as a
ClientTransaction
object, and can be obtained through the
IEnumeratorinterface that is returned by
the
GetEnumerator
()
()
()
()
method.A
BranchCollectionobject is obtained by
referencing the
Branches
property, which contains all of the client transactions that
are defined for that server transaction.This class implements the
IEnumerableinterface.The
BranchCollectionclass is derived from
the
System.Objectclass.
|
|
CancelContext
|
Additional information that can
be sent with a CANCEL request.
|
|
ClientTransaction
|
The
ClientTransactionclass defines a SIP
client transaction object located on a SIP proxy.A
ClientTransactionobject is created by
calling the
CreateBranch
()
()
()
()
method on a
ServerTransaction
object. To fork the proxy behavior,
ServerTransaction.CreateBranchcan be
called multiple times. However, a
ClientTransactionobject can service only
one request. To send the request, call the
SendRequest(Request)
method.To handle the responses for the request that are sent
by a specific client transaction, you must register for the
ResponseReceived
event. This event returns a
ResponseReceivedEventArgs
object whenever it is raised, and contains the response as a
Response
class object.Currently, the User Account Control (UAC)
client transaction case is not supported, where the server
originates a client transaction. Only proxy behaviors are available
for this classThe
ClientTransactionclass is derived from
the
Transaction
class.
|
|
CompilerErrorException
|
The
CompilerErrorExceptionclass defines the
exception that is thrown when an application manifest compiler
encounters an error.The
CompilerErrorExceptionclass is derived
from the
System.ApplicationExceptionclass.
|
|
ConnectionDroppedEventArgs
|
The
ConnectionDroppedEventArgsclass defines
the object that is returned by the
ConnectionDropped
event.The
ConnectionDroppedEventArgsclass is
derived from the
System.EventArgsclass.
|
|
ContactInfo
|
Contact entry that is used to
route requests to registered endpoints. This data type can only be
received as a parameter from SPL to the Dispatch handler.
|
|
DefaultRTCClassAttribute
|
The
DefaultRTCClassAttributeclass indicates
which derived class to use in place of a standard SIP class. For
example, a custom class to handle SIP responses can be designated
with this attribute, as long as the new response class inherits
from the
Response
class. To use
DefaultRTCClassAttribute, the custom
class must inherit from one of the following classes:
Request
,
Response
,
ClientTransaction
, or
ServerTransaction
.The
DefaultRTCClassAttributeclass is derived
from the
System.Attributeclass.
|
|
Header
|
The
Headerclass defines a SIP header.. A
Headerinstance may belong to multiple
HeaderCollectioninstances. The
Headerclass is derived from the
System.Objectclass.
|
|
HeaderCollection
|
Represents an ordered
collection of SIP headers. This class implements the
IEnumerableand
ICollectioninterfaces.The
HeaderCollectionclass is derived from
the
System.Objectclass.
|
|
Message
|
Base class for SIP message
classes.
|
|
NotificationReceivedEventArgs
|
Provides data for
NotificationReceivedEventHandler
events.
|
|
ObjectSpace
|
Implements an object space.
Object spaces are collections of objects that share a common lock
and lifetime.
|
|
Request
|
Represents SIP requests. The
Requestclass defines a SIP request sent
from a client transaction to a server transaction.Client
transactions are represented as a
ClientTransaction
object, and server transactions are represented as a
ServerTransaction
object. A request is sent by calling the
SendRequest(Request)
method. Any transaction may have only one associated
request.Requests are proxied by calling the
CreateBranch
()
()
()
()
and creating an associated
ClientTransactionobject for the proxied
request. To fork a request, call
ServerTransaction.CreateBranchonce for
each fork, and then call
ClientTransaction.SendRequeston each
element in the
BranchCollection
found at
Branches
.To generate a response message for a request, call
CreateResponse
()
()
()
()
on the associated
Requestobject. Populate the
Response
message with the proper status class and reason phrase, and
then pass it to
SendResponse(Response)
, by using the
ServerTransactionobject for the initial
request.When a response is returned for a specific request, a
ResponseReceived
event is raised on the
ClientTransactionobject that sent the
request, and a
ResponseReceivedEventArgs
object is supplied to the method that is provided to the
ResponseReceivedEventHandler
delegate.
|
|
RequestReceivedEventArgs
|
The
RequestReceivedEventArgsclass defines
information to an application regarding the arrival of a SIP
request.When a request has been successfully dispatched by the MSPL
message filter (see the
Dispatch
built-in function), an event containing a
RequestReceivedEventArgsobject will be
dispatched to the specified method (whose signature must match the
ResponseReceivedEventHandler
delegate).
RequestReceivedEventArgscontains the
request as the
Request
property.An instance of
ServerTransaction
is created as a property of
RequestReceivedEventArgs. This property
represents the new
servertransaction for the request. To
forward this request, call
CreateBranch
()
()
()
()
to create a
ClientTransaction
and call
SendRequest(Request)
, passing the
Request
object in the
RequestReceivedEventArgs.Requestproperty.
|
|
Response
|
The
Responseclass defines a SIP response
sent from a server transaction to a client transaction.To generate
a response message for a request, call
CreateResponse
()
()
()
()
on the associated
Request
object. Populate the
Responsemessage with the proper status
class and reason phrase, and then pass it to
SendResponse(Response)
, using the
ServerTransaction
object for the initial request.There are two methods for
receiving a response:First, the response is filtered by the MSPL
message filter and dispatched to a specific method that is defined
in your application. (For more information, see the
Dispatch
built-in MSPL function.) The method handling the response
must have a signature that matches the
RequestReceivedEventHandler
delegate. Second, the originating request that incurred the
response was sent from a specific
ClientTransaction
object instance that is running on your application. In this
case, the response is obtained by registering an event handler for
the
ResponseReceived
event. In both cases, the response is returned as the
Response
property, which contains a
Responseobject. In the case where a
ClientTransactionobject on the
application incurred the response, the
ClientTransaction
property will contain a reference to the specific client
transaction.
|
|
ResponseCollection
|
The
ResponseCollectionclass defines an
enumerable, read-only collection of
Response
objects.This class implements the
IEnumerableand
ICollectioninterfaces.The
ResponseCollectionclass is derived from
the
System.Objectclass.
|
|
ResponseReceivedEventArgs
|
The
ResponseReceivedEventArgsclass defines
information to an application regarding the arrival of a SIP
response, and contains a
Response
object for the response that generated the event.The
ResponseReceivedEventArgsobject is
returned in two ways:First, it is passed to a method defined on the
application and specified by a call to the
Dispatch
MSPL built-in function from the application manifest message
filter script. In this case, the method handling the dispatched
response must have a signature matching that of the
ResponseReceivedEventHandler
delegate.Second, it is passed to an event handler registered
for the
ResponseReceived
. This event is only available for
ClientTransaction
objects who have previously sent a request with
SendRequest(Request)
, and handle any responses associated with this request.The
ResponseReceivedEventArgsclass is
derived from the
System.Objectclass.
|
|
ServerAgent
|
Implements the server
agent.
|
|
ServerNotFoundException
|
The exception that is thrown
when server connection could not be established.
|
|
ServerTransaction
|
Represents SIP server
transactions.The
ServerTransactionclass defines a SIP
server transaction object located on a SIP proxy or user agent
server (UAS). A
ServerTransactioninstance is generated
as the
ServerTransaction
property, available on the
RequestReceivedEventArgs
object dispatched to a specific method by the MSPL script
filter. (For more information, see the
Dispatch
MSPL built-in function.) There are no public constructors
for this class.The request being serviced by this server
transaction can be forwarded by calling
CreateBranch
()
()
()
()
, which will create an associated
ClientTransaction
. To fork a message,
CreateBranchcan be called for each fork.
The collection of branches for this server transaction can be
obtained as a
BranchCollection
object by referencing the
Branches
property. Requests are sent by calling
SendRequest(Request)
on each branch.To send a response for the request the server
transaction was created to service, call
[M:Microsoft.Rtc.Sip.ServerTransaction.SendResponse(Microsoft.Rtc.Sip.Response]
with the
Response
object created by calling
CreateResponse(Int32)
on the
Request
object available in the
Request
property.The
ServerTransactionclass is derived from
the
Transaction
class.
|
|
Transaction
|
Base class for SIP transaction
classes.
|
|
UnauthorizedException
|
The exception that is thrown
when an authorized connection to the server is attempted and is
rejected by the server.
|