ServerChannel Class
From RemObjects Software
This is a RemObjects SDK Architecture entry
Feel free to add your notes to this topic below.
Overview (.NET)
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.
Namespace
Declaration (C#)
[LicenseProvider(typeof(ROLicenseProvider))] public abstract class ServerChannel : Channel, IChannel, IServerChannel, ISupportInitialize;
Hierarchy
- System.ComponentModel.Component
- RemObjects.SDK.Channel
- RemObjects.SDK.Server.ServerChannel
- RemObjects.SDK.Channel
Properties
| | | |
|---|---|---|
| Active | Boolean | Toggles whether the server component is active or not.
Set it to true (either from code or in the Property Pane) to have your server active and listening for requests from clients or set it to false to prevent new requests from being accepted. |
| Dispatchers | MessageDispatchers | Organizes the different Dispatchers configured for the server.
Depending on the server type, different dispatchers can be made accessible through different names (for example the HTTP based servers use the Path provided with the HTTP request to determine the dispatcher) or the dispatcher marked as Default will be used. Note: A design time editor for the Dispatcher collection is provided in the IDE, which you can invoke by clicking the ellipsis (...) button in the Properties Pane. You can use this editor to create new MessageDispatcher instances at design time and link them to the specific message components you have dropped onto your form. |
| ServeRodl | Boolean | Toggles whether clients can request the RODL file for this server via IRodlAccess or channel-specific means (such as by submitting a HTTP GET request to an HTTP server).
By default, this option is turned on; set this property to false if you want to prevent clients from retrieving the RODL file from the server. |
Methods
| | |
|---|---|
| Activate | Alias for the Open method. |
| Close | Closes the ServerChannel component and stops it from accepting any more incoming requests. |
| Deactivate | Alias for the Close method. |
| Open | Opens the ServerChannel component and starts accepting incoming requests.
Depending on the server type, this usually involves starting to listen on a network socket or polling some source for waiting messages. |
| StartListening | Alias for the Open method. |
| StopListening | Alias for the Close method. |
See Also
Product: RemObjects SDK
Current version: RemObjects SDK 'Vinci' (5.0)
Lists — Glossary — Features — How To — Components — Tools — Samples — Articles — Architecture — Issues
Categories: Text | RemObjects SDK | Architecture | Class | Component | .NET
