CrosserProtocol Class |
The CROSSER communication protocol.
This class parse data from IBaseTransport and make sure that the messages follow the rules of the protocol.
RPC/RMI, PUB/SUB and so on.
It also makes sure that other operations such as security, PING/PONG etc works as expected
Inheritance HierarchySystemObject
Crosser.Server.Modules.ProtocolProtocol
Crosser.Server.Modules.Protocol.CrosserCrosserProtocol
Crosser.Server.Modules.ProtocolProtocol
Crosser.Server.Modules.Protocol.CrosserCrosserProtocol
Namespace: Crosser.Server.Modules.Protocol.Crosser
Assembly: Crosser.Server (in Crosser.Server.dll) Version: 0.0.5
SyntaxC#
public class CrosserProtocol : Protocol, ICrosserProtocol, IProtocol, IDisposable
The CrosserProtocol type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | CrosserProtocol |
Ctor
|
Properties| Name | Description | |
|---|---|---|
 | AuthRequired |
True if the IBaseEndpoint requires authentication
(Inherited from Protocol.) |
 | ClientStats |
Clients statistics
(Inherited from Protocol.) |
| ConnectionContext |
Connection information IConnectionContext (Inherited from Protocol.) |
| Controllers |
The controller instances used by this connection
(Inherited from Protocol.) |
| ProtocolIdentifier |
Identifier for the protocol, passed into the ctor from implementing protocols
(Inherited from Protocol.) |
| PubSubHandler | IPubSubHandler module
(Inherited from Protocol.) |
| Server |
Reference to the IServer (Inherited from Protocol.) |
| Subscriptions |
Current subscriptions for this connection
(Inherited from Protocol.) |
| Transport | IBaseTransport for the protocol
(Inherited from Protocol.) |
Methods| Name | Description | |
|---|---|---|
| Dispose |
Clean up the resources used by the protocol
(Overrides ProtocolDispose.) |
 | EnsureController |
Makes sure that there is an instance of a specific controller.
Also makes sure that security is in place. Knowing what methods the connection can call.
(Inherited from Protocol.) |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| ExecuteCall |
Invoke the correct RPC controller/method with the payload.
Also handles return values when needed
(Inherited from Protocol.) |
| ExecuteCallSynchronously |
Invoke the correct RPC controller/method with the payload.
Also handles return values when needed
Will execute 1 operation at the time. Other operations will wait.
This will be executed when the IController or the method being invoked is decorated with the RunSynchronouslyAttribute (Inherited from Protocol.) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| FlushTransport |
Flushes the IBaseTransport write stream
(Inherited from Protocol.) |
| GetControllerDelegate |
Creates a ControllerDelegate to use when calling the controller/method
(Inherited from Protocol.) |
| GetDeadConnectionFrame |
Returns a dead connection frame for the crosser protocol
(Overrides ProtocolGetDeadConnectionFrame.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetPingFrame |
Returns a PING frame for the crosser protocol
(Overrides ProtocolGetPingFrame.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| HasControllerInstanceOf |
True if the controllers repository has a instance of the specific BinaryKey (Inherited from Protocol.) |
| InitClientStats |
Setup the properties on the ClientStats object
(Inherited from Protocol.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| ReadLoop |
Continuously reads the transport and parse messages -> track read-state -> take actions
(Overrides ProtocolReadLoop.) |
| RemoveController |
Removes a controller instance from the Controllers repository.
(Inherited from Protocol.) |
| Send(Byte) |
Enqueue the data to send and update the IServerStatistics (Overrides ProtocolSend(Byte).) |
| Send(BinaryKey, String, Byte) |
Builds the operation frame and add it to the outgoing queue
(Overrides ProtocolSend(BinaryKey, String, Byte).) |
| Send(Byte, Byte, Byte, Byte) |
Builds the operation frame and add it to the outgoing queue
(Overrides ProtocolSend(Byte, Byte, Byte, Byte).) |
| SendLoop |
Send loop that reads the OutQueue (Inherited from Protocol.) |
| StartPing |
If heartbeat is enabled on this endpoint the method will initiate a ping/pong sequence
(Inherited from Protocol.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
Fields| Name | Description | |
|---|---|---|
 | callbackId |
Buffer for callback-id.
(Inherited from Protocol.) |
| callbackIdPos |
Length to read from callbackId (Inherited from Protocol.) |
| Cancellation |
CancellationToken used in communication
(Inherited from Protocol.) |
| CloseReason |
Reason CloseReason for closing the connection
(Inherited from Protocol.) |
| controller |
Controller buffer, controller to call is within
(Inherited from Protocol.) |
| controllerPos |
The length to read from the controller (Inherited from Protocol.) |
| controllerToCall |
Cache controller since it will save time when same controller is called for each message
(Inherited from Protocol.) |
| data |
Last byte operation read from the IBaseTransport (Inherited from Protocol.) |
| disposed |
Flag for knowing if the object has been disposed
(Inherited from Protocol.) |
| iam |
Buffer for the IAM message operation
(Inherited from Protocol.) |
| iampos |
Size of the IAM message
(Inherited from Protocol.) |
| InQueue |
Queue for incoming data
(Inherited from Protocol.) |
| Interactive |
If true the protocol will respond with +OK messages for every valid operation. Only possible for full-duplex connections.
(Inherited from Protocol.) |
| IsAuthenticated |
True if the Authenticate(IProtocol) method returned true
(Inherited from Protocol.) |
| lastControllerAsByte |
Cache for last controller called
(Inherited from Protocol.) |
| lastControllerKey |
Cache for the last controller called as BinaryKey (Inherited from Protocol.) |
| lastMethodAsByte |
Cache for last method called
(Inherited from Protocol.) |
| lastMethodKey |
Cache for the last method called as BinaryKey (Inherited from Protocol.) |
| len |
Length to read from the IBaseTransport (Inherited from Protocol.) |
| locker |
For blocking simultaneous access to certain areas
(Inherited from Protocol.) |
| method |
Method buffer, method to call is within
(Inherited from Protocol.) |
| methodPos |
The length to read from the method (Inherited from Protocol.) |
| methodToCall |
Information about the method to be called ControllerDelegate (Inherited from Protocol.) |
| OutQueue |
Queue for outgoing data
(Inherited from Protocol.) |
| PubQueue |
Queue for messages published over a pub/sub pattern
(Inherited from Protocol.) |
| read |
Read buffer
(Inherited from Protocol.) |
| ReadState |
The ReadState for the ReadLoop
(Inherited from Protocol.) |
| run |
The readloop will continue as long as this flag is true.
When false the connection will be disposed
(Inherited from Protocol.) |
| size |
Size buffer
(Inherited from Protocol.) |
| sizepos |
Size position (for knowing size to read from size buffer)
(Inherited from Protocol.) |
| topic |
Topic parsed from the stream
(Inherited from Protocol.) |
| topicpos |
Length of the topic
(Inherited from Protocol.) |
| unsubcount |
Max messages to publish before doing automatic unsubscribe
(Inherited from Protocol.) |
| unsubcountpos |
Length of unsub-count
(Inherited from Protocol.) |
| validTopic |
Flag for knowing if the topic parsed is valid
(Inherited from Protocol.) |
| write |
Write buffer
(Inherited from Protocol.) |
See Also