org.sandev.basics.structs
Class IODeclSubscribeStruct

java.lang.Object
  org.sandev.basics.structs.IODeclSubscribeStruct

Direct Known Subclasses:

IODeclSubscribe

public class IODeclSubscribeStruct

extends java.lang.Object

A communication path representing an inbound asynchronous receive from another node instance (subscribe).

This structure is used as part of a NodeInstance. It is not persistent or transmittable, nor does it have any query, update or collection forms.

summary fields: mode target gateway optimize

Field Summary

protected java.lang.String	gateway The instance name of our local authorizer used as our gateway.
protected int	mode Communications between trusted nodes may be done directly, without authorization or encryption.
protected int	optimize Optimization, typically through direct method invocation, is done by default whenever possible.
protected java.lang.String	target The node instance name if using direct communication, otherwise the instance name of the corresponding authorizer node for secure communication.

Constructor Summary

IODeclSubscribeStruct()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

mode

protected int mode

Communications between trusted nodes may be done directly, without authorization or encryption. This is appropriate between trusted nodes running on the same server where there are no security issues. The alternative is secure communications. Secure communications must be used when communicating across servers.

enumerated constant values:

• _INVALID = 0
  
• _DIRECT = 1
  
• _SECURE = 2
  

declared invalid value: 0

optimize

protected int optimize

Optimization, typically through direct method invocation, is done by default whenever possible. However there are times where this optimization should be disabled (such as tracking all messages through a message server for debugging purposes, or whatever) so this field provides for turning off optimization.

declared default value: IF_POSSIBLE

enumerated constant values:

• _IF_POSSIBLE = 0
  
• _NEVER = 1
  

declared invalid value: -1

target

protected java.lang.String target

The node instance name if using direct communication, otherwise the instance name of the corresponding authorizer node for secure communication. This is the source we are subscribing to.

Length in characters, normal: 10 max: 80

gateway

protected java.lang.String gateway

The instance name of our local authorizer used as our gateway. If using direct communication, this field is ignored and should be left blank for clarity.

Length in characters, normal: 10 max: 80

Constructor Detail

IODeclSubscribeStruct

public IODeclSubscribeStruct()