instantreality 1.0

Component:
BehaviorController
Status:
experimental
Structure type:
concrete
Standard:
Avalon

SocketInterface

Simple socket interface node. If acceptPort is set, the node opens a server socket at the given port number. Otherwise it tries to connect as client using the address given by connectHost (name or IP address) and connectPort .To read data from the socket use a route from the Field "read"; to write data to the socket, route into the Field "write". Hint: according to IANA (http://www.iana.org/assignments/port-numbers), "Dynamic and/or Private Ports" (thus the ones neither "Well Known" nor "Registered") are those from 49152 through 65535. Choose from them if possible.

Inheritance

Code

XML encoding
<SocketInterface triggerName='Timer'
connectHost=''
connectPort='50000'
acceptPort='0'
logFeature=''
 />
Classic encoding
SocketInterface {
	triggerName "Timer"
	connectHost ""
	connectPort 50000
	acceptPort 0
	logFeature [""]
}

Interface

Filter: X3D only | Avalon only | All
id Name DataType PartType Default ValueType Description
MFString logFeature MFString inputOutput state, child, parent, route, eventIn, eventOut controls the logging of changes, state: log state changes (e.g. live), child: log child add/remove, parent: log parent add/remove, route: log route add/remove; eventIn: log receiving of events, eventOut: log sending of events: guiView, runtime system should create node-view, guiEdit: runtime system should create node-editeverything: log everything
SFInt32 acceptPort SFInt32 initializeOnly 0 Accept connections at the given port
SFInt32 connectPort SFInt32 initializeOnly 50000 Port to connect to at host connectHost
SFNode metadata SFNode inputOutput MetadataObject container for payload metadata inside MetadataSet element
SFString connectHost SFString initializeOnly Name of host to connect to.
SFString read SFString outputOnly Input buffer for socket read. Generates an EventOut when data was received.
SFString triggerName SFString initializeOnly Timer name of the dynamic context-slot which is used by the run-time environment (e.g. Jobs) to trigger the node. Life-Nodes will automatically connect the context-eventOutut to the triggerSlot-eventInput Slot.
SFString write SFString inputOnly Output buffer for socket write. Writes to the socket when an EventIn triggers.