instantreality 1.0

Component:
Networking
Status:
partly implemented
Structure type:
concrete
Standard:
Avalon

NetworkSensor

The NetworkSensor is intended to provide more efficient sending and receiving of events via a network connection than would normally be possible via an external API. It acts as a high speed gateway between a network stream and the X3D scene graph so routes can be set to/from it. It defines a set of fields to be sent/received over a connection.

Inheritance

Code

XML encoding
<NetworkSensor logFeature=''
enabled='TRUE'
description=''
command=''
commandType='-1'
triggerName='Timer'
channelId='1'
 />
Classic encoding
NetworkSensor {
	logFeature [""]
	enabled TRUE
	description ""
	command ""
	commandType -1
	triggerName "Timer"
	channelId "1"
}

Interface

Filter: X3D only | Avalon only | All
id Name DataType PartType Default ValueType Description
SFNode connection SFNode inputOutput NULL connection specifies the network connection to use.
SFString httpRequest SFString inputOnly Timer httprequest and httpResponse only apply when the protocol is HTTP.
MFString httpResponse MFString outputOnly httprequest and httpResponse only apply when the protocol is HTTP.
SFString channelId SFString initializeOnly 1 channelId identifies the NetworkSensor node instance which corresponds to a communication channel.
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-eventOutput to the triggerSlot-eventInput Slot.
SFInt32 commandType SFInt32 inputOutput -1 Category of command which can be send by command field. Command categories can be defined in the application. 0 is reserved for regular field data.
SFString command SFString inputOutput Command to be sent. Format can be freely defined. Command can be categorized through commandType field.
SFString description SFString inputOutput Text description to comment the sensor task. Can be used in run-time systems to give usefull feedback to the user and developer
SFBool enabled SFBool inputOutput TRUE Enables/disables the sensor node.
SFBool isActive SFBool outputOnly FALSE isActive true/false events are sent when the sensor gets active
SFTime triggerSlot SFTime inputOnly slot which is used internally to connect a dynamic context-slot which name is set by the triggerName value. Its used automatically to install run-time environment trigger.
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
SFNode metadata SFNode inputOutput MetadataObject container for payload metadata inside MetadataSet element