RemObjects.SDK.Server

Classes

Class Notes
ApplicationServer The ApplicationServer class provides base application startup infrastructure including Windows Service management and single instance checks.
ApplicationService
AsyncHttpContext
AsyncHttpRequest
AsyncHttpServer
AsyncHttpServerWorker
AsyncServer
AsyncTcpServer
AvailableMessage This class is used by the ServerMultiMessage class to get information about messages to use (see ServerMultiMessage for more details).
AvailableMessages Simple ArrayList descendant that contains instances of the AvailableMessage class. This class is used in ServerMultiMessage implementations...
CertificateBuilderFactory
CertificateWatcherFactory
Configuration
DynamoDBSessionManager The DynamoDBSessionManager class represents a session manager that stores session data in the DynamoDB NoSQL database.
EventSinkManager This class manages the available events and the lists of individual clients subscribed to these events on the server.
EventSinkProxy The EventSinkProxy class is the base class for the Remoting SDK proxy classes that are auto-generated from the RODL file for your event sinks. An EventSinkProxy represents the event interface...
ExtendedDispatcherList The ExtendedDispatcherList class is used by HTTP-based server channels to store a list of registered HTTP dispatchers like Data Abstract REST or OData dispatchers.
ExtendedHttpDispatcher The abstract ExtendedHttpDispatcher class provides the base implementation of the IHttpDispatcher interface. It provides default implementations for the NotifyDispose and CanHandlePath methods and exposes the abstract Process...
HtmlServerInfo Static class that provides helper methods for general server information page creation:
HttpApiDispatcher
HttpApiDispatcherElement
HttpFileDispatcher The HttpFileDispatcher class provides allows to serve HTTP resource requests.
HttpServer
HttpServerChannel Base class for HttpSysServerChannel and HttpSysServerChannel server channels. This class provides properties and events common for all HTTP server channels.
HttpServerRequest
HttpServerResponse
HttpSysBinding Collections of instances of this class are used by HttpSysServerChannel and HttpSysSuperHttpServerChannel server channels to store hostname and port binding information.
HttpSysServerChannel This is a simple HTTP server channel. It is based on http.sys and the .NET wrapper classes. http.sys is a kernel level HTTP stack provided by Microsoft, available in Windows starting from XP SP2. It provides the basic HTTP functionality for IIS on these...
HttpSysServerChannelInfo
HttpSysSuperHttpServerChannel This is a SuperHTTP server channel. It is based on http.sys and the .NET wrapper classes. http.sys is a kernel level HTTP stack provided by Microsoft, available in Windows starting from XP SP2. It provides the basic HTTP functionality for IIS on these...
Invoker This is the base class for custom Invoker classes created in the _Invk source files auto-generated from your RODL Library.
IpHttpServerChannel The IpHttpServerChannel is the default server component used to make your services accessible via the HTTP protocol.
IpHttpServerChannelInfo The IpHttpServerChannelInfo class is used internally by the IpHttpServerChannel to store all information about the request currently processed, including related HttpServerRequest and HttpServerResponse instances.
IpServerChannelInfo The IpServerChannelInfo class is inherited from the ServerChannelInfo class and implements the IIpServerChannelInfo interface.
IpSuperHttpServerChannel Enhanced HTTP based server which provides a sophisticated and flexible communication channel that uses persistent connections to enable true asynchronous calls and server callbacks.
IpSuperTcpServerChannel Server side of the enhanced TCP based channel.
IpTcpServerChannel This is a Server Channel implementation for the raw TCP protocol.
JavaScriptDispatcherElement
JavaScriptHttpDispatcher The JavaScriptHttpDispatcher class provides very easy way to add the
Listener
LocalServerChannel LocalServerChannel implements a server that makes services available for consumption from within the same executable via a LocalClientChannel.
MemoryMessageQueue The MemoryMessageQueue class represents a queue of serialized messages stored in memory. This class is used internally in the Remoting SDK whenever the MemoryMessageQueueManager is used as the message queue manager.
MemoryMessageQueueManager Concrete implementation of a MessageQueueManager that stores the queued message in memory.
MemorySession The MemorySession class represents session data stored by the MemorySessionManager.
MemorySessionManager This is a session manager implementation that uses memory storage for the session data. As such, access to session data is very efficient, but session data will not be persisted when the server is restarted, nor can it be shared between several instances...
MessageDispatcher This class represents a message dispatcher and is used by the Remoting SDK server channel components to associate a Message class with certain (or all) incoming requests.
MessageDispatchers The MessageDispatchers class maintains a collection of dispatchers configured for a given server.
MessageQueue The MessageQueue class implements the Interface IMessageQueue interface and is used as base a class for all Remoting SDK implementations of a serialized message queues. Message queues are used by MessageQueueManager infrastructure to...
MessageQueueManager The MessageQueueManager is a base class for all Message Queue Manager implementations. Message Queue Managers is a server component used to store and manage serialized server-sent event data.
NamedPipeServerChannel The NamedPipeServerChannel class implements the server side of Named Pipes based communication channels. Named pipes can be used to provide communication between processes on the same computer or between processes on different computers across a network...
NetworkServer The NetworkServer class ties together the network connectivity components like server channel, messages etc grouping them together into single configurable class. The NetworkServer is the core of the entire Remoting SDK Server Configuration System...
OlympiaMessageQueueManager The OlympiaMessageQueueManager class is a concrete implementation of the MessageQueueManager that uses an Olympia Server instance to store the queued event messages.
OlympiaServerSessionManager The OlympiaServerSessionManager class represents a session manager that stores session data in the Olympia State Server.
QueryString
RodlMerger The RodlMerger class is an internal static class that provides methods to merge two or more RODL files. This class is used by the HtmlServerInfo class to merge all RODL resources embedded into the server's assembly when the server's RODL is requested by a client application.
RodlResource The RodlResource class is used to simplify access to RODL resources embedded into an assembly.
SerializableSession The SerializableSession class is used as a base class for out-of-process session classes. This class provides save-to-stream and load-from-stream functionality as well as internal cache used to speed up handling of complex objects.
Server
ServerBinding
ServerChannel This is the abstract base class for all Server Channel implementations. You will descend from this class when implementing a custom server channel, or use one of the existing descendants.
ServerChannelElement
ServerChannelInfo The ServerChannelInfo is a base class for holding server channel info. This particular implementation is responsible for holding ServerChannel though it is extended in inherited classes.
ServerConfigurationSection
ServerMainForm
ServerMessageCollection
ServerMessageElement
ServerMultiMessage The ServerMultiMessage class implements a Message that is able to cummunicate in different formats (f.e. binary and SOAP) via the same server URL.
ServerSecurityOptions The ServerSecurityOptions class provides a unified way to set security options used by the
Service The Service base class provides a base implementation that can (but need not) be used as the ancestor for your custom service implementations. This class implements the Interface IActivatableService, Interface IChannelAwareService, Interface IDisposableService...
ServiceActivator The ServiceActivator abstract class is the base class for custom Activator classes created in the **_Invk** source files auto-generated from the RODL library.
ServiceInfo
ServiceManager This class is used internally by the remoting framework to locate and maintain a list of all services registered for a given server.
SessionManager This is the abstract base class for all session manager implementations. You will descend from this class when implementing a custom session manager, or use one of the existing descendants.
SessionManagerElement
SslOptionsElement
StaticServiceInvoker
SuperHttpServerChannel The SuperHttpServerChannel class is a base class for the server side of the sophisticated and flexible HTTP based communication channel, which uses persistent connections to enable true asynchronous calls and server callbacks. This...
SuperHttpServerConnection SuperHttpServerConnection is used as a server-side representation for a connection with a particular client through a SuperHttp channel. The SuperHttpServer channel will obtain SuperHttpServerConnection objects for every established incoming connection...
SuperHttpServerResponse SuperHttpServerResponse represents response information from the SuperHttpServer channel. This class is internally used by the SuperHttp channels infrastructure.
SuperHttpWebProcessor
SuperTcpServerChannel SuperTcpServerChannel implements the server side of the sophisticated and flexible TCP based communication channel that uses persistent connections to enable true asynchronous calls and server callbacks...
SuperTcpServerChannelWorker
TcpServer
WebChannelInfo
WebProcessor

Interfaces

Interface Notes
IActivatableService This interface can be implemented by service implementations that want to be notified for activation and deactivation (i.e. before and after they will be asked to serve a remote request).
IApiDispatcherConfiguration
IArgumentParser The IArgumentParser interface represents command-line arguments parser. This parser
ICertificateBuilder
ICertificateWatcherFactory
IChannelAwareService This interface can be implemented by service implementations that need to access the underlying server channel component that was used to receive the request.
IClassFactory This is the common base interface for all class factory implementations.
ICustomMessageQueueHandler The interface defines event message queue handler that is able to manage event receivers in the case when Super channels are used. Unlike the plain (ie non-Super) channels where server-sent events are polled...
IDisposableService This interface can be implemented by service implementations that want to control whether a particular instance can be disposed upon completing the current request.
IEventDispatcher The Interface IEventDispatcher interface defines entity that is able to push events data to the clients, f.e. Super-channel connections. The MessageQueueManager class stores internal list of those entities to be able to actively push serialized events...
IEventSinkManager The interface provides abstract interface for concrete event sink manager implementations.
IHttpDispatcher The IHttpDispatcher interface represents an HTTP requests dispatcher.
IHttpResponse The IHttpResponse interface represents HTTP responses from RemObject SDK-based servers.
IHttpServer The IHttpServer interface represents a server channel that is able to register and unregister additional IHttpDispatcher instances. For example: the Register method of this interface is used by the RestSchemaDispatcher class to register itself...
IIpHttpServerChannelInfo This interface extends the IIpServerChannelInfo to provide access to HTTP specific information about the incoming request. In particular, it provides the details of the HTTP Request that the request has come in with.
IIpServerChannelInfo This interface extends the IServerChannelInfo to provide access to Internet Pack specific information about the incoming request. In particular, it provides the Connection that the request has come in with.
IJavaScriptDispatcherConfiguration The IJavaScriptDispatcherConfiguration interface is used by the Remoting SDK Server Configuration System to represent requested server message(s) configuration. There is no need to implement this interface...
IListener
IMessageAwareService This interface can be implemented by service implementations that need to access the message component that was used to receive the request.
IMessageQueue The Interface IMessageQueue interface represents a queue of serialized messages. Concrete implementations of this interface (for example in the MemoryMessageQueue class) are used by the MessageQueueManager class descemndants to manage serialized server...
IMessageQueueManager The interface represents a Message Queue Manager, a server component used to store and manage serialized server-sent event data.
INetworkServer 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...
INetworkServerChannelInfo The interface defined to allow inspecting both local (server side) and remote (client side) endpoints of an IP-based client connection on the server. The reference to this interface can be obtained from any service method code. [Read more](/Server_FAQs_(Remoting_SDK)#How_can_I_get_IP_address_of_the_remote_client_from_the_service_code...
INetworkServerConfiguration
IRecipientListEventTargets The IRecipientListEventTargets interface implementation can be used to define Multicast Events (.NET and Delphi) recipients when an event is dispatched by an EventSinkManager.
IRodlProvider
IRolesAwareService The IRolesAwareService interface represents a Remoting SDK service that is able to check Roles required to invoke particular service operations.
ISelectiveEventTargets The ISelectiveEventTargets interface implementation can be used to define Multicast Events (.NET and Delphi) recipients when an event is dispatched by an EventSinkManager.
IServerChannelConfiguration The IServerChannelConfiguration interface is used by the Remoting SDK Server Configuration System to represent requested server channel configuration. There is no need to implement this interface in the user...
IServerChannelInfo This interface can be accessed by services implementing the IChannelAwareService (or descending from the Service) using the ServerChannelInfo property to get more information about the server channel that received this request.
IServerEventChannel The IServerEventChannel interface represents an entity that is able to dispatch events from the server to the client.
IServerMessageConfiguration The IServerMessageConfiguration interface is used by the Remoting SDK Server Configuration System to represent requested server message(s) configuration. There is no need to implement this interface in the...
IServiceActivator
IServiceHttpInfo The IServiceHttpInfo interface allows to get information about a Schema that is related with a data abstract service.
IServiceInvoker
IServiceManagerExtender
ISession The Interface ISession interface represents a user session. Sessions are managed by classes implementing the Interface ISessionManager interface (f.e. MemorySessionManager class).
ISessionManager The interface provides abstract interface for concrete session manager implementations.
ISessionManagerConfiguration The ISessionManagerConfiguration interface is used by the Remoting SDK Server Configuration System to represent requested server message(s) configuration. There is no need to implement this interface in the...
ISslOptionsConfiguration
IZeroConfServerChannel The IZeroConfServerChannel interface represents the information about specified server channel: such as port that the server will listening on.

Enums

Enum Notes
ApplicationRunAction Value of this enum descibes which action the ApplicationServer class should perform.
ClientAccessPolicyType
ServerChannelType The ServerChannelType enumeration is used in the Remoting SDK Server Configuration System to represent type of the server channel being configured. The IServerChannelConfiguration interface exposes value of this type.
ServerMessageType The ServerMessageType enumeration is used in the Remoting SDK Server Configuration System to represent type of the server message being configured. The IServerMessageConfiguration interface exposes value of this type.
SessionManagerType The SessionManagerType enumeration is used in the Remoting SDK Server Configuration System to represent type of the server message being configured. The ISessionManagerConfiguration interface exposes value of this type.

Exceptions

Exception Notes
OlympiaException The OlympiaException class represents exception raised by the Olympia state server.

Attributes

Attribute Notes
Abstract Used in RODL-based generated code to mark abstract services to prevent them from being called.
ApiHeaderParameter
ApiMethod
ApiQueryParameter
DefaultClientChannel
Documentation
EventSinkProxy Marks the class to implement the proxy for an event sink.
Invoker Marks the class to implement an invoker.
ServerChannel
ServerConfiguration
ServerInfrastructure
Service This attribute is used to mark types that implement a service available via remote access. The ServiceManager will look for this attribute when searching for classes when a request for the service comes in.
ServiceMethod
ServiceRequiresLogin
ZeroConfServiceType ZeroConfServiceTypeAttribute is an attribute class which defines and holds your service type name. In Remoting SDK this attribute is used to register your service for discovering through ZeroConf.