Share via

SipEndpoint Members

  • Article

Represents a registration server-based endpoint.

The SipEndpoint type exposes the following members.

Constructors

  Name Description
Public method SipEndpoint(String, SipAuthenticationProtocols, SipTransportType, String) Initializes a new instance of the class.
Public method SipEndpoint(String, SipAuthenticationProtocols, SipTransportType, String, Int32, Boolean, RealTimeConnectionManager, String) Initializes a new instance of the class.

Top

Properties

  Name Description
Public property AllowedAuthenticationProtocols Gets the allowed set of authentication protocols to be used for this endpoint.
Public property AllowNoAuthentication Gets whether the client allows communication with a server that does not authenticate messages from this client.
Public property ApplicationContext Gets or sets the application context. (Inherited from RealTimeEndpoint.)
Public property ApplicationUserAgent Gets or sets the application user agent string. (Inherited from RealTimeEndpoint.)
Public property AuthenticationProtocol Gets the authentication protocol currently in use with the server.
Public property ConnectionManager Gets or sets the connection manager. (Inherited from RealTimeEndpoint.)
Public property CredentialCache Gets the credentials cache needed to authenticate the application with servers.
Public property DefaultDomain (Inherited from RealTimeEndpoint.)
Public property DesiredSessionTimerInterval Gets or sets the desired session timer interval of the application. (Inherited from RealTimeEndpoint.)
Public property DisableAutomaticRetryForRetryAfter (Inherited from RealTimeEndpoint.)
Public property DisableReferredBySigning Obsolete. (Inherited from RealTimeEndpoint.)
Public property DisableRegisterRefreshForConnectionDrop Gets or sets whether automatic register refresh is allowed due to connection drop.
Public property DisplayName Gets or sets the user name preferred by the application for the local user. (Inherited from RealTimeEndpoint.)
Public property Gruu Gets or sets the [GRUU] of the endpoint, if any. (Inherited from RealTimeEndpoint.)
Public property Id Gets the [ID] for this endpoint. (Inherited from RealTimeEndpoint.)
Public property IsDialogResiliencySupported (Inherited from RealTimeEndpoint.)
Public property IsEndpointThrottled Gets and sets whether the endpoint should be throttled.
Public property IsSessionTimerSupported Gets or sets the default policy used for the session timer. (Inherited from RealTimeEndpoint.)
Public property MaximumRegisterRedirectionAttempts Gets or sets the number of redirect attempts allowed for registration.
Public property MaximumSessionConnectDuration (Inherited from RealTimeEndpoint.)
Public property MinimumSessionTimerInterval Gets or sets the minimum session interval. (Inherited from RealTimeEndpoint.)
Public property RegisterMethods Gets or sets the methods supported by this endpoint to be specified in the Register message.
Public property RegistrationState Gets the registration state of the endpoint.
Public property ReliableProvisionalResponsePolicy Gets or sets the default policy for supporting 100rel extension feature. (Inherited from RealTimeEndpoint.)
Public property Server Gets the server currently used by the endpoint.
Public property ServerPort Gets the port used to connect to the server.
Public property SipInstance Gets and sets the sipInstance parameter value used in the contact header for Register.
Protected property SyncRoot Gets the [SyncRoot] of this endpoint. (Inherited from RealTimeEndpoint.)
Public property TransportType Gets the transport type used for connecting to the server.
Public property Uri Represents the [URI] of the identity owning this endpoint. (Inherited from RealTimeEndpoint.)
Public property UserAgent Gets the user agent string used for messages. (Inherited from RealTimeEndpoint.)
Public property Uuid Gets the universally unique identifier (UUID) of the endpoint.

Top

Methods

  Name Description
Public method AddFeatureParameter(String) Adds a feature parameter. (Inherited from RealTimeEndpoint.)
Public method AddFeatureParameter(String, String) Adds a feature parameter. (Inherited from RealTimeEndpoint.)
Public method AddSipExtension Adds an extension to the list of supported extensions for Invite. (Inherited from RealTimeEndpoint.)
Public method BeginRegister(AsyncCallback, Object) Starts an asynchronous Register operation for the current endpoint.
Public method BeginRegister(IEnumerable<(Of <<'(SignalingHeader>)>>), AsyncCallback, Object) Starts an asynchronous Register operation for the current endpoint.
Public method BeginSendMessage(MessageType, RealTimeAddress, SendMessageOptions, AsyncCallback, Object) (Inherited from RealTimeEndpoint.)
Public method BeginSendMessage(MessageType, RealTimeAddress, ContentType, array<Byte>[]()[][], AsyncCallback, Object) Sends a message to another endpoint. (Inherited from RealTimeEndpoint.)
Public method BeginSendMessage(MessageType, RealTimeAddress, ContentType, array<Byte>[]()[][], IEnumerable<(Of <<'(SignalingHeader>)>>), AsyncCallback, Object) Sends a message. (Inherited from RealTimeEndpoint.)
Public method BeginTerminate Terminates the endpoint and cleans up active sessions and resources. (Inherited from RealTimeEndpoint.)
Public method BeginUnregister Starts an asynchronous process to unregister the current endpoint.
Public method EndRegister Waits for the asynchronous Register operation to complete.
Public method EndSendMessage Waits for the pending [SendMessage] operation to complete. (Inherited from RealTimeEndpoint.)
Public method EndTerminate Completes the asynchronous [Terminate] operation. (Inherited from RealTimeEndpoint.)
Public method EndUnregister Waits for the asynchronous Unregister operation to complete.
Public method Equals (Inherited from Object.)
Protected method Finalize (Inherited from Object.)
Public method GetFeatureParameterValue Gets the value of the given parameter. (Inherited from RealTimeEndpoint.)
Public method GetHashCode (Inherited from Object.)
Public method GetSupportedSipExtensions Gets the list of extensions supported by this endpoint. (Inherited from RealTimeEndpoint.)
Public method GetType (Inherited from Object.)
Protected method MemberwiseClone (Inherited from Object.)
Protected method ProcessNotifyReceived (Inherited from RealTimeEndpoint.)
Public method Register()()()() Synchronously registers the current endpoint.
Public method Register(IEnumerable<(Of <<'(SignalingHeader>)>>)) Synchronously registers the current endpoint.
Protected method RegisterForPageModeMessages Register for page mode messages. (Inherited from RealTimeEndpoint.)
Public method RemoveFeatureParameter Removes a feature parameter matching the name if it exists. (Inherited from RealTimeEndpoint.)
Public method SendMessage(MessageType, RealTimeAddress, ContentType, array<Byte>[]()[][]) Sends a message synchronously. (Inherited from RealTimeEndpoint.)
Public method SendMessage(MessageType, RealTimeAddress, ContentType, array<Byte>[]()[][], IEnumerable<(Of <<'(SignalingHeader>)>>)) Sends a message synchronously. (Inherited from RealTimeEndpoint.)
Public method Terminate Terminates the endpoint and cleans up active sessions and resources. The endpoint is no longer usable. (Inherited from RealTimeEndpoint.)
Public method ToString Returns the string representation of the object. (Inherited from RealTimeEndpoint.)
Public method Unregister Synchronously unregisters the endpoint.
Protected method UnregisterForPageModeMessages Unregister for pagemode messages. (Inherited from RealTimeEndpoint.)

Top

Events

  Name Description
Public event AuthenticationProtocolChanged Raised when the protocol used between the client and server changes.
Public event MessageReceived Raised when a message is received. (Inherited from RealTimeEndpoint.)
Public event RegistrationStateChanged Raised when the Registration state changes.
Public event ServerChanged Raised when the server is changed.
Public event ServerPortChanged Raised when the server port is changed.
Public event SessionReceived Raised when a new invitation is received. (Inherited from RealTimeEndpoint.)

Top

Fields

  Name Description
Public fieldStatic member DefaultRtcRealm The default realm used when communicating with the server.

Top

See Also

Reference

SipEndpoint Class

Microsoft.Rtc.Signaling Namespace