MonitorEndpoint Class |
Endpoint that will allow server configuration and server statistics to be sent to clients connected on the endpoint
Inheritance HierarchySystemObject
Crosser.Server.Modules.EndpointBaseEndpoint
Crosser.Server.Modules.EndpointHttpEndpoint
Crosser.Server.Modules.EndpointMonitorEndpoint
Crosser.Server.Modules.EndpointBaseEndpoint
Crosser.Server.Modules.EndpointHttpEndpoint
Crosser.Server.Modules.EndpointMonitorEndpoint
Namespace: Crosser.Server.Modules.Endpoint
Assembly: Crosser.Server (in Crosser.Server.dll) Version: 0.0.5
SyntaxC#
public class MonitorEndpoint : HttpEndpoint, IMonitorEndpoint, IHttpEndpoint, IBaseEndpoint, IDisposable
The MonitorEndpoint type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | MonitorEndpoint |
Ctor
|
Properties| Name | Description | |
|---|---|---|
 | AllowedOrigins |
Accepts all origins by default ('*'). See AllowedOrigins for example
(Inherited from HttpEndpoint.) |
| AllowedPingFails |
How many continous failed pings is allowed before disposing the connection?
(Inherited from BaseEndpoint.) |
| AuthRequired |
True if the client need to authenticate before being able to send/receive other data.
If true the client have to authenticate before the AuthTimeout expires.
(Inherited from BaseEndpoint.) |
| Backlog |
How large the backlog for incoming connections will be
(Inherited from BaseEndpoint.) |
| Certificate |
The server-side certificate X509Certificate2. Certificates can be loaded with the helper => GetCertificateFromStore(String, StoreLocation) (Inherited from BaseEndpoint.) |
| CertificateRequired |
If true the client need to provide a certificate
(Inherited from BaseEndpoint.) |
| Interactive |
If true the full-duplex client will get confirmation messages for every operation.
Default is true, but client can turn of when sending initial message of just by calling interact+/interact-.
(Inherited from BaseEndpoint.) |
| IPEndpoint |
Connection endpoint
(Inherited from BaseEndpoint.) |
| Location |
The location of the endpoint, default is 'localhost'
(Inherited from BaseEndpoint.) |
| Password |
Basic authentication Password
|
| PingTimeout |
The PING timeout for this endpoint.
Less or equal to zero will disable PING/PONG on the endpoint.
By default this is set to PingTimeout (Inherited from BaseEndpoint.) |
| Port |
Port number for the endpoint
(Inherited from BaseEndpoint.) |
| ReadBufferSize |
Size of the read buffer for the ITransport on the endpoint
(Inherited from BaseEndpoint.) |
| Root |
Path to dashboard
|
| RootIsRelative |
If true the root-path is expected to be relative to execution folder. If false the root-path is expected to be absolute
|
| SecureRequired |
True if the endpoint uses encrypted communication
(Inherited from BaseEndpoint.) |
| Server |
Reference to the IServer (Inherited from BaseEndpoint.) |
| SslProtocols |
The accepted SslProtocols. Default is Tls12 (Inherited from BaseEndpoint.) |
| UseNagleAlgorithm |
Default true
(Inherited from BaseEndpoint.) |
| Username |
Basic authentication UserName
|
| WriteBufferSize |
Size of the write buffer for the ITransport on the endpoint
(Inherited from BaseEndpoint.) |
Methods| Name | Description | |
|---|---|---|
| Config |
Returns a JSON representation of the MonitorEndpoint configuration
(Overrides HttpEndpointConfig.) |
| Dispose |
Cleans up resources and stop accepting client
(Inherited from BaseEndpoint.) |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
 | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| ProcessConnectionAttempt |
Creates the endpoints IHttpTransport and setup the streams for IHttpMonitor (Overrides HttpEndpointProcessConnectionAttempt(Socket).) |
| Start |
Starts listening for connections on the specified location:port
(Overrides HttpEndpointStart.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
See Also