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

  • Reference: RemObjects.SDK.Server.dll
  • Namespace: RemObjects.SDK.Server
  • Platforms: .NET Core, .NET Framework, .NET Standard


 

ApiDispatcher

 

property ApiDispatcher: HttpApiDispatcher read write;

 

HttpApiDispatcher ApiDispatcher { get; set; }

 

var ApiDispatcher: HttpApiDispatcher { get{} set{} }

 

Property ApiDispatcher() As HttpApiDispatcher

Certificate

 

property Certificate: X509Certificate2 read write;

 

X509Certificate2 Certificate { get; set; }

 

var Certificate: X509Certificate2 { get{} set{} }

 

Property Certificate() As X509Certificate2

CertificateFileName

 

property CertificateFileName: String read write;

 

String CertificateFileName { get; set; }

 

var CertificateFileName: String { get{} set{} }

 

Property CertificateFileName() As String

CertificateStore

 

property CertificateStore: String read write;

 

String CertificateStore { get; set; }

 

var CertificateStore: String { get{} set{} }

 

Property CertificateStore() As String

CertificateSubject

 

property CertificateSubject: String read write;

 

String CertificateSubject { get; set; }

 

var CertificateSubject: String { get{} set{} }

 

Property CertificateSubject() As String

CertificateThumbprint

 

property CertificateThumbprint: String read write;

 

String CertificateThumbprint { get; set; }

 

var CertificateThumbprint: String { get{} set{} }

 

Property CertificateThumbprint() As String

EnableZeroConf

 

property EnableZeroConf: Boolean read write;

 

Boolean EnableZeroConf { get; set; }

 

var EnableZeroConf: Boolean { 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; }

 

var EventManager: EventSinkManager { get{} set{} }

 

Property EventManager() As EventSinkManager

IsActive

 

property IsActive: Boolean read;

 

Boolean IsActive { get; }

 

var IsActive: Boolean { get{} }

 

ReadOnly Property IsActive() As Boolean

JavaScriptDispatcher

 

property JavaScriptDispatcher: JavaScriptHttpDispatcher read write;

 

JavaScriptHttpDispatcher JavaScriptDispatcher { get; set; }

 

var JavaScriptDispatcher: JavaScriptHttpDispatcher { get{} set{} }

 

Property JavaScriptDispatcher() As JavaScriptHttpDispatcher

MessageQueue

Gets the MessageQueueManager instance being used by the Network Server.

 

property MessageQueue: MessageQueueManager read write;

 

MessageQueueManager MessageQueue { get; set; }

 

var MessageQueue: MessageQueueManager { get{} set{} }

 

Property MessageQueue() As MessageQueueManager

Port

 

property Port: Int32 read write;

 

Int32 Port { get; set; }

 

var Port: Int32 { get{} set{} }

 

Property Port() As Int32

RegisterServerMessage

 

method RegisterServerMessage(message: IMessage)

 

void RegisterServerMessage(IMessage message)

 

func RegisterServerMessage(_ message: IMessage)

 

Sub RegisterServerMessage(message As IMessage)

Parameters:

  • message:

ServerChannel

Gets the ServerChannel instance being used by the Network Server.

 

property ServerChannel: ServerChannel read write;

 

ServerChannel ServerChannel { get; set; }

 

var ServerChannel: ServerChannel { get{} set{} }

 

Property ServerChannel() As ServerChannel

ServerMessage

 

property ServerMessage: IMessage read;

 

IMessage ServerMessage { get; }

 

var ServerMessage: IMessage { get{} }

 

ReadOnly Property 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; }

 

var ServerMessages: IList<IMessage> { get{} }

 

ReadOnly Property ServerMessages() As IList<IMessage>

ServiceGroup

Allows to get/set Service Groups

 

property ServiceGroup: String read write;

 

String ServiceGroup { get; set; }

 

var ServiceGroup: String { get{} set{} }

 

Property ServiceGroup() As String

SessionManager

Gets the SessionManager instance being used by the Network Server.

 

property SessionManager: SessionManager read write;

 

SessionManager SessionManager { get; set; }

 

var SessionManager: SessionManager { get{} set{} }

 

Property SessionManager() As SessionManager

SetCertificateWatcher

 

method SetCertificateWatcher(watcherFactory: ICertificateWatcherFactory)

 

void SetCertificateWatcher(ICertificateWatcherFactory watcherFactory)

 

func SetCertificateWatcher(_ watcherFactory: ICertificateWatcherFactory)

 

Sub SetCertificateWatcher(watcherFactory As ICertificateWatcherFactory)

Parameters:

  • watcherFactory:

SetupConnectionSecurity

 

method SetupConnectionSecurity(certificate: X509Certificate2)

 

void SetupConnectionSecurity(X509Certificate2 certificate)

 

func SetupConnectionSecurity(_ certificate: X509Certificate2)

 

Sub SetupConnectionSecurity(certificate As X509Certificate2)

Parameters:

  • certificate:

SetupServer

 

method SetupServer(configuration: INetworkServerConfiguration)

 

void SetupServer(INetworkServerConfiguration configuration)

 

func SetupServer(_ configuration: INetworkServerConfiguration)

 

Sub SetupServer(configuration As INetworkServerConfiguration)

Parameters:

  • configuration:

Start

Starts the server and opens the server channel.

 

method Start

 

void Start()

 

func Start()

 

Sub Start()

Started

 

event Started: EventHandler

 

delegate EventHandler Started()

 

__event EventHandler: Started!

 

Event Started As EventHandler

Starting

 

event Starting: EventHandler

 

delegate EventHandler Starting()

 

__event EventHandler: Starting!

 

Event Starting As EventHandler

Stop

Closes the server channel and stops the server.

 

method Stop

 

void Stop()

 

func Stop()

 

Sub Stop()

Stopped

 

event Stopped: EventHandler

 

delegate EventHandler Stopped()

 

__event EventHandler: Stopped!

 

Event Stopped As EventHandler

Stopping

 

event Stopping: EventHandler

 

delegate EventHandler Stopping()

 

__event EventHandler: Stopping!

 

Event Stopping As EventHandler

TlsProtocols

Comma separated list of supported Tls protocols
Default value is "Tls,Tls11,Tls12,Tls13"

 

property TlsProtocols: String read write;

 

String TlsProtocols { get; set; }

 

var TlsProtocols: String { get{} set{} }

 

Property TlsProtocols() As String

UnregisterServerMessage

 

method UnregisterServerMessage(message: IMessage)

 

void UnregisterServerMessage(IMessage message)

 

func UnregisterServerMessage(_ message: IMessage)

 

Sub UnregisterServerMessage(message As IMessage)

Parameters:

  • message:

UseTLS

Allow to use TLS (Transport Layer Security) protocol

 

property UseTLS: Boolean read write;

 

Boolean UseTLS { get; set; }

 

var UseTLS: Boolean { get{} set{} }

 

Property UseTLS() As Boolean

 

ApiDispatcher

 

property ApiDispatcher: HttpApiDispatcher read write;

 

HttpApiDispatcher ApiDispatcher { get; set; }

 

var ApiDispatcher: HttpApiDispatcher { get{} set{} }

 

Property ApiDispatcher() As HttpApiDispatcher

Certificate

 

property Certificate: X509Certificate2 read write;

 

X509Certificate2 Certificate { get; set; }

 

var Certificate: X509Certificate2 { get{} set{} }

 

Property Certificate() As X509Certificate2

CertificateFileName

 

property CertificateFileName: String read write;

 

String CertificateFileName { get; set; }

 

var CertificateFileName: String { get{} set{} }

 

Property CertificateFileName() As String

CertificateStore

 

property CertificateStore: String read write;

 

String CertificateStore { get; set; }

 

var CertificateStore: String { get{} set{} }

 

Property CertificateStore() As String

CertificateSubject

 

property CertificateSubject: String read write;

 

String CertificateSubject { get; set; }

 

var CertificateSubject: String { get{} set{} }

 

Property CertificateSubject() As String

CertificateThumbprint

 

property CertificateThumbprint: String read write;

 

String CertificateThumbprint { get; set; }

 

var CertificateThumbprint: String { get{} set{} }

 

Property CertificateThumbprint() As String

EnableZeroConf

 

property EnableZeroConf: Boolean read write;

 

Boolean EnableZeroConf { get; set; }

 

var EnableZeroConf: Boolean { 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; }

 

var EventManager: EventSinkManager { get{} set{} }

 

Property EventManager() As EventSinkManager

IsActive

 

property IsActive: Boolean read;

 

Boolean IsActive { get; }

 

var IsActive: Boolean { get{} }

 

ReadOnly Property IsActive() As Boolean

JavaScriptDispatcher

 

property JavaScriptDispatcher: JavaScriptHttpDispatcher read write;

 

JavaScriptHttpDispatcher JavaScriptDispatcher { get; set; }

 

var JavaScriptDispatcher: JavaScriptHttpDispatcher { get{} set{} }

 

Property JavaScriptDispatcher() As JavaScriptHttpDispatcher

MessageQueue

Gets the MessageQueueManager instance being used by the Network Server.

 

property MessageQueue: MessageQueueManager read write;

 

MessageQueueManager MessageQueue { get; set; }

 

var MessageQueue: MessageQueueManager { get{} set{} }

 

Property MessageQueue() As MessageQueueManager

Port

 

property Port: Int32 read write;

 

Int32 Port { get; set; }

 

var Port: Int32 { 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; }

 

var ServerChannel: ServerChannel { get{} set{} }

 

Property ServerChannel() As ServerChannel

ServerMessage

 

property ServerMessage: IMessage read;

 

IMessage ServerMessage { get; }

 

var ServerMessage: IMessage { get{} }

 

ReadOnly Property 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; }

 

var ServerMessages: IList<IMessage> { get{} }

 

ReadOnly Property ServerMessages() As IList<IMessage>

ServiceGroup

Allows to get/set Service Groups

 

property ServiceGroup: String read write;

 

String ServiceGroup { get; set; }

 

var ServiceGroup: String { get{} set{} }

 

Property ServiceGroup() As String

SessionManager

Gets the SessionManager instance being used by the Network Server.

 

property SessionManager: SessionManager read write;

 

SessionManager SessionManager { get; set; }

 

var SessionManager: SessionManager { get{} set{} }

 

Property SessionManager() As SessionManager

TlsProtocols

Comma separated list of supported Tls protocols
Default value is "Tls,Tls11,Tls12,Tls13"

 

property TlsProtocols: String read write;

 

String TlsProtocols { get; set; }

 

var TlsProtocols: String { get{} set{} }

 

Property TlsProtocols() As String

UseTLS

Allow to use TLS (Transport Layer Security) protocol

 

property UseTLS: Boolean read write;

 

Boolean UseTLS { get; set; }

 

var UseTLS: Boolean { get{} set{} }

 

Property UseTLS() As Boolean

 

RegisterServerMessage

 

method RegisterServerMessage(message: IMessage)

 

void RegisterServerMessage(IMessage message)

 

func RegisterServerMessage(_ message: IMessage)

 

Sub RegisterServerMessage(message As IMessage)

Parameters:

  • message:

SetCertificateWatcher

 

method SetCertificateWatcher(watcherFactory: ICertificateWatcherFactory)

 

void SetCertificateWatcher(ICertificateWatcherFactory watcherFactory)

 

func SetCertificateWatcher(_ watcherFactory: ICertificateWatcherFactory)

 

Sub SetCertificateWatcher(watcherFactory As ICertificateWatcherFactory)

Parameters:

  • watcherFactory:

SetupConnectionSecurity

 

method SetupConnectionSecurity(certificate: X509Certificate2)

 

void SetupConnectionSecurity(X509Certificate2 certificate)

 

func SetupConnectionSecurity(_ certificate: X509Certificate2)

 

Sub SetupConnectionSecurity(certificate As X509Certificate2)

Parameters:

  • certificate:

SetupServer

 

method SetupServer(configuration: INetworkServerConfiguration)

 

void SetupServer(INetworkServerConfiguration configuration)

 

func SetupServer(_ configuration: INetworkServerConfiguration)

 

Sub SetupServer(configuration As INetworkServerConfiguration)

Parameters:

  • configuration:

Start

Starts the server and opens the server channel.

 

method Start

 

void Start()

 

func Start()

 

Sub Start()

Stop

Closes the server channel and stops the server.

 

method Stop

 

void Stop()

 

func Stop()

 

Sub Stop()

UnregisterServerMessage

 

method UnregisterServerMessage(message: IMessage)

 

void UnregisterServerMessage(IMessage message)

 

func UnregisterServerMessage(_ message: IMessage)

 

Sub UnregisterServerMessage(message As IMessage)

Parameters:

  • message:

 

Started

 

event Started: EventHandler

 

delegate EventHandler Started()

 

__event EventHandler: Started!

 

Event Started As EventHandler

Starting

 

event Starting: EventHandler

 

delegate EventHandler Starting()

 

__event EventHandler: Starting!

 

Event Starting As EventHandler

Stopped

 

event Stopped: EventHandler

 

delegate EventHandler Stopped()

 

__event EventHandler: Stopped!

 

Event Stopped As EventHandler

Stopping

 

event Stopping: EventHandler

 

delegate EventHandler Stopping()

 

__event EventHandler: Stopping!

 

Event Stopping As EventHandler