INetworkServer

Overview

The INetworkServer interface is used by the Remoting SDK Server Configuration System to represent the network connectivity components like server channel, messages etc grouped together into single configurable class. The Network server is the core of the entire Remoting SDK Server Configuration System as it holds the server connectivity components and implement their configuration logic. This interface provides access to the core Network Server components as the server channel, server messages etc to allow theit fine-tuning as well as it exposes the methods needed to open or close the server channel and to load the network server configuration.

Introduction of the INetworkServer interface makes the Remoting SDK Server Configuration System more flexible as it allows to provide custom network server implementations (f.e. for testing purposes) and to use custom network server classes descended from the base NetwokServer class (f.e. when some more advanced server components instantiation logic is needed).

Location

Implemented in

 

add_Started

 

method add_Started(value: EventHandler)

 

void add_Started(EventHandler value)

 

Sub add_Started(value As EventHandler)

Parameters:

  • value:

add_Starting

 

method add_Starting(value: EventHandler)

 

void add_Starting(EventHandler value)

 

Sub add_Starting(value As EventHandler)

Parameters:

  • value:

add_Stopped

 

method add_Stopped(value: EventHandler)

 

void add_Stopped(EventHandler value)

 

Sub add_Stopped(value As EventHandler)

Parameters:

  • value:

add_Stopping

 

method add_Stopping(value: EventHandler)

 

void add_Stopping(EventHandler value)

 

Sub add_Stopping(value As EventHandler)

Parameters:

  • value:

ApiDispatcher

 

property ApiDispatcher: HttpApiDispatcher read;

 

HttpApiDispatcher ApiDispatcher { get; }

 

Property ReadOnly ApiDispatcher As HttpApiDispatcher

Certificate

 

property Certificate: X509Certificate2 read write;

 

X509Certificate2 Certificate { get; set; }

 

Property Certificate As X509Certificate2

CertificateFileName

 

property CertificateFileName: String read write;

 

String CertificateFileName { get; set; }

 

Property CertificateFileName As String

CertificateSubject

 

property CertificateSubject: String read write;

 

String CertificateSubject { get; set; }

 

Property CertificateSubject As String

CertificateThumbprint

 

property CertificateThumbprint: String read write;

 

String CertificateThumbprint { get; set; }

 

Property CertificateThumbprint As String

EnableZeroConf

 

property EnableZeroConf: Boolean read write;

 

Boolean EnableZeroConf { get; set; }

 

Property EnableZeroConf As Boolean

EventManager

Gets the EventSinkManager instance being used by the Network Server.

 

property EventManager: EventSinkManager read write;

 

EventSinkManager EventManager { get; set; }

 

Property EventManager As EventSinkManager

IsActive

 

property IsActive: Boolean read;

 

Boolean IsActive { get; }

 

Property ReadOnly IsActive As Boolean

JavaScriptDispatcher

Gets the JavaScriptHttpDispatcher instance being used by the Network Server.

 

property JavaScriptDispatcher: JavaScriptHttpDispatcher read;

 

JavaScriptHttpDispatcher JavaScriptDispatcher { get; }

 

Property ReadOnly JavaScriptDispatcher As JavaScriptHttpDispatcher

MessageQueue

Gets the MessageQueueManager instance being used by the Network Server.

 

property MessageQueue: MessageQueueManager read write;

 

MessageQueueManager MessageQueue { get; set; }

 

Property MessageQueue As MessageQueueManager

Port

 

property Port: Int32 read write;

 

Int32 Port { get; set; }

 

Property Port As Int32

RegisterServerMessage

 

method RegisterServerMessage(message: IMessage)

 

void RegisterServerMessage(IMessage message)

 

Sub RegisterServerMessage(message As IMessage)

Parameters:

  • message:

remove_Started

 

method remove_Started(value: EventHandler)

 

void remove_Started(EventHandler value)

 

Sub remove_Started(value As EventHandler)

Parameters:

  • value:

remove_Starting

 

method remove_Starting(value: EventHandler)

 

void remove_Starting(EventHandler value)

 

Sub remove_Starting(value As EventHandler)

Parameters:

  • value:

remove_Stopped

 

method remove_Stopped(value: EventHandler)

 

void remove_Stopped(EventHandler value)

 

Sub remove_Stopped(value As EventHandler)

Parameters:

  • value:

remove_Stopping

 

method remove_Stopping(value: EventHandler)

 

void remove_Stopping(EventHandler value)

 

Sub remove_Stopping(value As EventHandler)

Parameters:

  • value:

ServerChannel

Gets the ServerChannel instance being used by the Network Server.

 

property ServerChannel: ServerChannel read write;

 

ServerChannel ServerChannel { get; set; }

 

Property ServerChannel As ServerChannel

ServerMessage

 

property ServerMessage: IMessage read;

 

IMessage ServerMessage { get; }

 

Property ReadOnly ServerMessage As IMessage

ServerMessages

Gets list of the Message instances being used by the Network Server.

 

property ServerMessages: IList<IMessage> read;

 

IList<IMessage> ServerMessages { get; }

 

Property ReadOnly ServerMessages As IList<IMessage>

SessionManager

Gets the SessionManager instance being used by the Network Server.

 

property SessionManager: SessionManager read write;

 

SessionManager SessionManager { get; set; }

 

Property SessionManager As SessionManager

SetCertificateWatcher

 

method SetCertificateWatcher(watcherFactory: ICertificateWatcherFactory)

 

void SetCertificateWatcher(ICertificateWatcherFactory watcherFactory)

 

Sub SetCertificateWatcher(watcherFactory As ICertificateWatcherFactory)

Parameters:

  • watcherFactory:

SetupConnectionSecurity

 

method SetupConnectionSecurity(certificate: X509Certificate2)

 

void SetupConnectionSecurity(X509Certificate2 certificate)

 

Sub SetupConnectionSecurity(certificate As X509Certificate2)

Parameters:

  • certificate:

SetupServer

 

method SetupServer(configuration: INetworkServerConfiguration)

 

void SetupServer(INetworkServerConfiguration configuration)

 

Sub SetupServer(configuration As INetworkServerConfiguration)

Parameters:

  • configuration:

Start

Starts the server and opens the server channel.

 

method Start

 

void Start()

 

Sub Start

Started

 

event Started: EventHandler;

 

delegate EventHandler Started()

 

Event Started As EventHandler

Starting

 

event Starting: EventHandler;

 

delegate EventHandler Starting()

 

Event Starting As EventHandler

Stop

Closes the server channel and stops the server.

 

method Stop

 

void Stop()

 

Sub Stop

Stopped

 

event Stopped: EventHandler;

 

delegate EventHandler Stopped()

 

Event Stopped As EventHandler

Stopping

 

event Stopping: EventHandler;

 

delegate EventHandler Stopping()

 

Event Stopping As EventHandler

UnregisterServerMessage

 

method UnregisterServerMessage(message: IMessage)

 

void UnregisterServerMessage(IMessage message)

 

Sub UnregisterServerMessage(message As IMessage)

Parameters:

  • message:

UseTLS

 

property UseTLS: Boolean read write;

 

Boolean UseTLS { get; set; }

 

Property UseTLS As Boolean

 

ApiDispatcher

 

property ApiDispatcher: HttpApiDispatcher read;

 

HttpApiDispatcher ApiDispatcher { get; }

 

Property ReadOnly ApiDispatcher As HttpApiDispatcher

Certificate

 

property Certificate: X509Certificate2 read write;

 

X509Certificate2 Certificate { get; set; }

 

Property Certificate As X509Certificate2

CertificateFileName

 

property CertificateFileName: String read write;

 

String CertificateFileName { get; set; }

 

Property CertificateFileName As String

CertificateSubject

 

property CertificateSubject: String read write;

 

String CertificateSubject { get; set; }

 

Property CertificateSubject As String

CertificateThumbprint

 

property CertificateThumbprint: String read write;

 

String CertificateThumbprint { get; set; }

 

Property CertificateThumbprint As String

EnableZeroConf

 

property EnableZeroConf: Boolean read write;

 

Boolean EnableZeroConf { get; set; }

 

Property EnableZeroConf As Boolean

EventManager

Gets the EventSinkManager instance being used by the Network Server.

 

property EventManager: EventSinkManager read write;

 

EventSinkManager EventManager { get; set; }

 

Property EventManager As EventSinkManager

IsActive

 

property IsActive: Boolean read;

 

Boolean IsActive { get; }

 

Property ReadOnly IsActive As Boolean

JavaScriptDispatcher

Gets the JavaScriptHttpDispatcher instance being used by the Network Server.

 

property JavaScriptDispatcher: JavaScriptHttpDispatcher read;

 

JavaScriptHttpDispatcher JavaScriptDispatcher { get; }

 

Property ReadOnly JavaScriptDispatcher As JavaScriptHttpDispatcher

MessageQueue

Gets the MessageQueueManager instance being used by the Network Server.

 

property MessageQueue: MessageQueueManager read write;

 

MessageQueueManager MessageQueue { get; set; }

 

Property MessageQueue As MessageQueueManager

Port

 

property Port: Int32 read write;

 

Int32 Port { get; set; }

 

Property Port As Int32

ServerChannel

Gets the ServerChannel instance being used by the Network Server.

 

property ServerChannel: ServerChannel read write;

 

ServerChannel ServerChannel { get; set; }

 

Property ServerChannel As ServerChannel

ServerMessage

 

property ServerMessage: IMessage read;

 

IMessage ServerMessage { get; }

 

Property ReadOnly ServerMessage As IMessage

ServerMessages

Gets list of the Message instances being used by the Network Server.

 

property ServerMessages: IList<IMessage> read;

 

IList<IMessage> ServerMessages { get; }

 

Property ReadOnly ServerMessages As IList<IMessage>

SessionManager

Gets the SessionManager instance being used by the Network Server.

 

property SessionManager: SessionManager read write;

 

SessionManager SessionManager { get; set; }

 

Property SessionManager As SessionManager

UseTLS

 

property UseTLS: Boolean read write;

 

Boolean UseTLS { get; set; }

 

Property UseTLS As Boolean

 

add_Started

 

method add_Started(value: EventHandler)

 

void add_Started(EventHandler value)

 

Sub add_Started(value As EventHandler)

Parameters:

  • value:

add_Starting

 

method add_Starting(value: EventHandler)

 

void add_Starting(EventHandler value)

 

Sub add_Starting(value As EventHandler)

Parameters:

  • value:

add_Stopped

 

method add_Stopped(value: EventHandler)

 

void add_Stopped(EventHandler value)

 

Sub add_Stopped(value As EventHandler)

Parameters:

  • value:

add_Stopping

 

method add_Stopping(value: EventHandler)

 

void add_Stopping(EventHandler value)

 

Sub add_Stopping(value As EventHandler)

Parameters:

  • value:

RegisterServerMessage

 

method RegisterServerMessage(message: IMessage)

 

void RegisterServerMessage(IMessage message)

 

Sub RegisterServerMessage(message As IMessage)

Parameters:

  • message:

remove_Started

 

method remove_Started(value: EventHandler)

 

void remove_Started(EventHandler value)

 

Sub remove_Started(value As EventHandler)

Parameters:

  • value:

remove_Starting

 

method remove_Starting(value: EventHandler)

 

void remove_Starting(EventHandler value)

 

Sub remove_Starting(value As EventHandler)

Parameters:

  • value:

remove_Stopped

 

method remove_Stopped(value: EventHandler)

 

void remove_Stopped(EventHandler value)

 

Sub remove_Stopped(value As EventHandler)

Parameters:

  • value:

remove_Stopping

 

method remove_Stopping(value: EventHandler)

 

void remove_Stopping(EventHandler value)

 

Sub remove_Stopping(value As EventHandler)

Parameters:

  • value:

SetCertificateWatcher

 

method SetCertificateWatcher(watcherFactory: ICertificateWatcherFactory)

 

void SetCertificateWatcher(ICertificateWatcherFactory watcherFactory)

 

Sub SetCertificateWatcher(watcherFactory As ICertificateWatcherFactory)

Parameters:

  • watcherFactory:

SetupConnectionSecurity

 

method SetupConnectionSecurity(certificate: X509Certificate2)

 

void SetupConnectionSecurity(X509Certificate2 certificate)

 

Sub SetupConnectionSecurity(certificate As X509Certificate2)

Parameters:

  • certificate:

SetupServer

 

method SetupServer(configuration: INetworkServerConfiguration)

 

void SetupServer(INetworkServerConfiguration configuration)

 

Sub SetupServer(configuration As INetworkServerConfiguration)

Parameters:

  • configuration:

Start

Starts the server and opens the server channel.

 

method Start

 

void Start()

 

Sub Start

Stop

Closes the server channel and stops the server.

 

method Stop

 

void Stop()

 

Sub Stop

UnregisterServerMessage

 

method UnregisterServerMessage(message: IMessage)

 

void UnregisterServerMessage(IMessage message)

 

Sub UnregisterServerMessage(message As IMessage)

Parameters:

  • message:

 

Started

 

event Started: EventHandler;

 

delegate EventHandler Started()

 

Event Started As EventHandler

Starting

 

event Starting: EventHandler;

 

delegate EventHandler Starting()

 

Event Starting As EventHandler

Stopped

 

event Stopped: EventHandler;

 

delegate EventHandler Stopped()

 

Event Stopped As EventHandler

Stopping

 

event Stopping: EventHandler;

 

delegate EventHandler Stopping()

 

Event Stopping As EventHandler

See Also

  • NetworkServer
  • IServerConfiguration

  • Remoting SDK Server Configuration System