Implements the server agent.
The ServerAgenttype exposes the following members.
Constructors
Name | Description | |
---|---|---|
ServerAgent(ApplicationManifest) | Simplified version of the constructor for use by script-only applications. | |
ServerAgent(Object, ApplicationManifest) | Creates a new server agent for the supplied application object and with the supplied application maifest. |
Properties
Name | Description | |
---|---|---|
ActiveWorkerThreads | Returns the number of worker threads currently executing inside ProcessEvent. | |
InsideRtcHost | Indicates whether the server agent is running inside RTCHost.exe. Not intended for third-party developers. | |
MessagesInServerAgent | Returns the number of messages correctly contained in ServerAgent's state manager. | |
Role | The current server role. | |
ServerFqdn | The server's machine FQDN | |
ServerPool | The name of the pool to which the server belongs. | |
ServerProcess | Server process. | |
SPLLoggerPresent | SPL Logger present | |
WaitHandle | Internal handle used to signal that there is pending input from the SIP server that the server agent needs to process. |
Methods
Name | Description | |
---|---|---|
AddAuthorizedHost | Adds an entry to the authorized host table | |
CheckDisposed | Throws an [ObjectDisposedException] if the object is in the disposed state. | |
Cleanup | Clean up function to clear static state. Supports RtcHost infrastructure, not intended for third-party developers. | |
CloseHandle | The CloseHandlemethod closes an open Microsoft Windows object handle. | |
Dispose () () () () | Releases all resources used by this object. | |
Dispose(Boolean) | Releases the unmanaged resources used by this object and optionally releases the managed resources. | |
Equals | (Inherited from Object.) | |
Finalize | Finalizer of an instance for this class.(Overrides Object . . :: . . Finalize () () () () .) | |
GetHashCode | (Inherited from Object.) | |
GetType | (Inherited from Object.) | |
MemberwiseClone | (Inherited from Object.) | |
OnConnectionDropped | Raises the [ConnectionDropped] event. | |
ProcessEvent | Dequeues an event from the server queue and processes it. | |
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. | |
RemoveAuthorizedHost | Removes an entry from the authorized host table | |
ToString | (Inherited from Object.) | |
WaitForServerAvailable | Waits for the RTCSRV process to startup. |
Events
Name | Description | |
---|---|---|
AuthorizedHostOperationCompleted | Occurs when Add/RemoveAuthorizedHost operations complete. | |
ConnectionDropped | Occurs when the connection to the server has been dropped. For example, when the server has crashed. | |
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. |