Implements the server agent.

The ServerAgenttype exposes the following members.

Constructors

  Name Description
Public method ServerAgent(ApplicationManifest) Simplified version of the constructor for use by script-only applications.
Public method ServerAgent(Object, ApplicationManifest) Creates a new server agent for the supplied application object and with the supplied application maifest.
Top

Properties

  Name Description
Public property ActiveWorkerThreads Returns the number of worker threads currently executing inside ProcessEvent.
Public property Static member InsideRtcHost Indicates whether the server agent is running inside RTCHost.exe. Not intended for third-party developers.
Public property MessagesInServerAgent Returns the number of messages correctly contained in ServerAgent's state manager.
Public property Role The current server role.
Public property Static member ServerFqdn The server's machine FQDN
Public property Static member ServerPool The name of the pool to which the server belongs.
Public property Static member ServerProcess Server process.
Public property Static member SPLLoggerPresent SPL Logger present
Public property WaitHandle Internal handle used to signal that there is pending input from the SIP server that the server agent needs to process.
Top

Methods

  Name Description
Public method AddAuthorizedHost Adds an entry to the authorized host table
Protected method CheckDisposed Throws an [ObjectDisposedException] if the object is in the disposed state.
Public method Static member Cleanup Clean up function to clear static state. Supports RtcHost infrastructure, not intended for third-party developers.
Public method Static member CloseHandle The CloseHandlemethod closes an open Microsoft Windows object handle.
Public method Dispose () () () () Releases all resources used by this object.
Protected method Dispose(Boolean) Releases the unmanaged resources used by this object and optionally releases the managed resources.
Public method Equals (Inherited from Object.)
Protected method Finalize Finalizer of an instance for this class.(Overrides Object . . :: . . Finalize () () () () .)
Public method GetHashCode (Inherited from Object.)
Public method GetType (Inherited from Object.)
Protected method MemberwiseClone (Inherited from Object.)
Protected method OnConnectionDropped Raises the [ConnectionDropped] event.
Public method ProcessEvent Dequeues an event from the server queue and processes it.
Public method ProcessEventOnThreadPool Dequeues events from the server queue and processes them on ThreadPool thread. This method takes into account the number of active worker threads before queuing events on threadpool.
Public method RemoveAuthorizedHost Removes an entry from the authorized host table
Public method ToString (Inherited from Object.)
Public method Static member WaitForServerAvailable Waits for the RTCSRV process to startup.
Top

Events

  Name Description
Public event AuthorizedHostOperationCompleted Occurs when Add/RemoveAuthorizedHost operations complete.
Public event ConnectionDropped Occurs when the connection to the server has been dropped. For example, when the server has crashed.
Public event UnhandledException Occurs when an unhandled exception is caught by the ServerAgent dispatcher. The application can return true to allow the process to continue or false to cause the exception to be re-thrown.
Top

See also