The SipEndpointtype exposes the following members.
Constructors
Name | Description | |
---|---|---|
SipEndpoint | Overloaded. |
Methods
Name | Description | |
---|---|---|
AddFeatureParameter | Overloaded. | |
AddSipExtension |
Adds an extenstion to the list of supported
extensions for Invite. If an incoming Invite message has a required
header that does not exist in this list, it will be automatically
rejected with 420. Once an item is added to this list, it cannot be
removed. This list does not affect outgoing Invites for which the
application is responsible for adding any necessary headers such as
"Supported" or "Require" headers for specific SIP
extensions. (Inherited from
RealTimeEndpoint.) |
|
BeginRegister | Overloaded. | |
BeginSendMessage | Overloaded. | |
BeginTerminate |
Terminates the endpoint and cleans up active
sessions and resources. The endpoint is no longer
usable. (Inherited from
RealTimeEndpoint.) |
|
BeginUnregister |
Starts an asynchronous process to unregister
the current endpoint. This method always succeeds.
|
|
EndRegister |
Completes the asynchronous Register
operation.
|
|
EndSendMessage |
Waits for the pending SendMessage operation to
complete. (Inherited from
RealTimeEndpoint.) |
|
EndTerminate |
Completes the asynchronous Terminate
operation. (Inherited from
RealTimeEndpoint.) |
|
EndUnregister |
Finishes the asynchronous Unregister
operation.
|
|
Equals | (Inherited from Object.) | |
Finalize | (Inherited from Object.) | |
GetFeatureParameterValue |
Gets the value of the given
parameter. (Inherited from
RealTimeEndpoint.) |
|
GetHashCode | (Inherited from Object.) | |
GetSupportedSipExtensions |
Gets the list of extensions supported by this
endpoint. By default, this list is populated with extensions
understood by the platform. The application can add other
extensions it can support. Incoming Invite messages will be
automatically rejected with 420 response if it contains a Requires
header with option-tag that is not present in this
list. (Inherited from
RealTimeEndpoint.) |
|
GetType | (Inherited from Object.) | |
MemberwiseClone | (Inherited from Object.) | |
ProcessNotifyReceived |
Event handler for incoming notify
request. (Inherited from
RealTimeEndpoint.) |
|
Register | Overloaded. | |
RegisterForPageModeMessages |
Register for page mode
messages. (Inherited from
RealTimeEndpoint.) |
|
RemoveFeatureParameter |
Removes a feature parameter matching the name
if it exists. (Inherited from
RealTimeEndpoint.) |
|
SendMessage | Overloaded. | |
Terminate |
Terminates the endpoint and cleans up active
sessions and resources. The endpoint is no longer
usable. (Inherited from
RealTimeEndpoint.) |
|
ToString |
Returns the string representation of the
object. (Inherited from
RealTimeEndpoint.) |
|
Unregister |
Synchronously unregisters the endpoint. It is
not recommended for a UI thread.
|
|
UnregisterForPageModeMessages |
Unregister for pagemode
messages (Inherited from
RealTimeEndpoint.) |
Fields
Name | Description | |
---|---|---|
DefaultRtcRealm |
The default realm used when communicating with
the server. This realm is used when adding a NetworkCredential to
the CredentialCache.
|
Properties
Name | Description | |
---|---|---|
AllowedAuthenticationProtocols |
Specifies the allowed set of authentication
protocols to be used for this endpoint.
|
|
AllowNoAuthentication |
Gets the flag that indicates whether the
client allows communicating with a server that does not challenge
messages from this client.
|
|
ApplicationContext |
Gets or sets the application
context. (Inherited from
RealTimeEndpoint.) |
|
ApplicationUserAgent |
Gets or sets the application user agent
string. This is appended to the user agent header. (Inherited
from
RealTimeEndpoint.) |
|
AuthenticationProtocol |
The authentication protocol currently in use
with the server. If there is no security context established with
the server, the default value of SipAuthenticationProtocols.None is
returned.
|
|
ConnectionManager |
Gets or sets the connection
manager. (Inherited from
RealTimeEndpoint.) |
|
CredentialCache |
This property returns a credentials cache that
can be used by the application to supply credentials needed to
authenticate the application with servers.
|
|
DefaultDomain |
Gets the default domain of the endpoint
URI. (Inherited from
RealTimeEndpoint.) |
|
DesiredSessionTimerInterval |
Gets or sets the desired session timer
interval of the application. This is used only for the initial
Invite or Response. (Inherited from
RealTimeEndpoint.) |
|
DisableAutomaticRetryForRetryAfter |
Gets or sets the flag that indicates if the
endpoint should retry requests for failed responses that contain
retry-after header. By default, this is false and hence the
platform will retry once more for such requests. If the
applications wants to disable this automatic retry behavior, this
property can be set to true. Typicaly, this might be needed for an
application whose primary task is to perform back to back operation
for two sessions where automatci retry might interefere with the
ability to offer quick feedback via the back to back seesion so
that the remote can take corrective measures. (Inherited from
RealTimeEndpoint.) |
|
DisableReferredBySigning |
Obsolete.
Disables signing of Referred-By headers for
endpoint if configured to use MTLS. (Inherited from
RealTimeEndpoint.) |
|
DisableRegisterRefreshForConnectionDrop |
Gets or sets the value that controls whether
automatic register refresh should be allowed due to connection
drop. When the current connection is disconnected for some reason
and the endpoint uses either client connection manager or a server
connection manager that does not listen, a register refresh attempt
is made. By default, this property is set to false (Register
Refresh occurs when connection drops). If disabled, connection drop
would set the registration state to Unregistered. This flag is
ignored when the server connection manager is used and the manager
is listening for incoming connections as there is no automatic
register refresh attempted.
|
|
DisplayName |
Gets or sets the user name preferred by the
application for the local user. This name will be used as the
display name of the user in outgoing messages. This property
indicates the display name to use in outgoing
messages. (Inherited from
RealTimeEndpoint.) |
|
Gruu |
Gets the GRUU of the endpoint, if any. Can be
null. (Inherited from
RealTimeEndpoint.) |
|
Id |
Represents the ID for this endpoint. The same
URI may be used on different endpoints. The ID is unique across all
endpoints having the same URI. (Inherited from
RealTimeEndpoint.) |
|
IsDialogResiliencySupported |
Gets or sets value indicating if recovery
attempt from failure in a dialog's signaling path is
supported (Inherited from
RealTimeEndpoint.) |
|
IsEndpointThrottled |
Gets or sets the Boolean value indicating if
the endpoint should be throttled or not.
|
|
IsSessionTimerSupported |
Gets or sets the default policy used for the
session timer. This value is inherited by incoming/outgoing
sessions unless an incoming session requires it. The application
can override the policy per session. (Inherited from
RealTimeEndpoint.) |
|
MaximumRegisterRedirectionAttempts |
Gets or sets the value that controls the
number of redirect attempts allowed for registration. The default
value is 3. The allowed range is from 0 to 5. The value of 0
disables automatic redirection.
|
|
MaximumSessionConnectDuration |
Maximum duration in minutes to wait for final
response. (Inherited from
RealTimeEndpoint.) |
|
MinimumSessionTimerInterval |
Gets or sets the minimum session interval. Any
session-expires interval less than this value in messages will not
be accepted. (Inherited from
RealTimeEndpoint.) |
|
RegisterMethods |
Gets or sets the methods supported by this
endpoint to be specified in the Register message. By default, this
is set to support subscription and signaling sessions. The
application should normally set this property before calling the
Register method. If this is set after the Register method is
completed, it will take effect when a Register refresh
occurs.
|
|
RegistrationState |
Gets the Registration state of endpoint.
|
|
ReliableProvisionalResponsePolicy |
Gets or sets the default policy for supporting
100rel extension feature. If an application supports this then the
remote can ask for this when sending provisional responses which
will result in PRACK message geting sent to acknowledge the
response. An application should set this to set the policy globally
for all sessions created. For outgoing session,
ExtensionFeatureSupport.Required is not recommended since it is not
meaningful and it likely to be rejected by the remote side with 420
(BadExtension) response. (Inherited from
RealTimeEndpoint.) |
|
Server |
Gets the server currently used by the
endpoint.
|
|
ServerPort |
Gets the port used to connect to the server.
This is the port currently used to connect to the server or the
port configured by the application if there is no active connection
to the server. If the server is unknown, then 0 is returned.
|
|
SipInstance |
Gets the sipInstance parameter value used in
the contact header for Register (used by the server to generate the
GRUU).
|
|
SyncRoot |
Get the syncroot of this
endpoint. (Inherited from
RealTimeEndpoint.) |
|
TransportType |
Gets the transport type used for connecting to
the server. This is the same as what is specified by the
application or the transport used for connecting to an
autodiscovered server. In case of autoconfiguration, this property
will change only after a successful connection to the server.
|
|
Uri |
Represents the URI of the identity owning this
endpoint. (Inherited from
RealTimeEndpoint.) |
|
UserAgent |
Gets the user agent string used for messages.
This includes the platform's header followed by the header supplied
by the application, if any. (Inherited from
RealTimeEndpoint.) |
|
Uuid |
Gets the universally unique identifier.
|
Events
Name | Description | |
---|---|---|
AuthenticationProtocolChanged |
Raised when the protocol used between the
client and server changes.
|
|
MessageReceived |
Raised when a message is
received. (Inherited from
RealTimeEndpoint.) |
|
RegistrationStateChanged |
Raised when the Registration state
changes.
|
|
ServerChanged |
Raised when the server is changed, as when the
server is autodiscovered or when redirection occurs.
|
|
ServerPortChanged |
Raises the server port is changed, as when the
server is autodiscovered or when redirection occurs.
|
|
SessionReceived |
Raised when a new invitation is
received. (Inherited from
RealTimeEndpoint.) |