instantreality 1.0

Component:
Engine
Status:
fully implemented
Structure type:
concrete
Standard:
Avalon

ExternalInterfaceJob

This job enables external connections to avalon over a networkconnection.

Inheritance

Code

XML encoding
<ExternalInterfaceJob triggerName='ExternalInterface'
netID='0'
userID='-1'
address=''
port='4848'
autonet='TRUE'
communicationType='multicomm'
maxEventPerFrame='-1'
sendResponse='TRUE'
whiteboardMCTTL='4'
networkEventLogLevel='0'
enabled='TRUE'
runTime='0'
logFeature=''
 />
Classic encoding
ExternalInterfaceJob {
	triggerName "ExternalInterface"
	netID 0
	userID "-1"
	address ""
	port 4848
	autonet TRUE
	communicationType "multicomm"
	maxEventPerFrame -1
	sendResponse TRUE
	whiteboardMCTTL 4
	networkEventLogLevel 0
	enabled TRUE
	runTime 0
	logFeature [""]
}

Interface

Filter: X3D only | Avalon only | All
id Name DataType PartType Default ValueType Description
SFString triggerName SFString initializeOnly ExternalInterface name of the dynamic context-slot which is used by the run-time the Jobs to trigger Live-nodes. Life-Jobs will automatically connect the triggerSlot-output to the context-slot.
SFInt32 netID SFInt32 initializeOnly 0 Network ID to identify the server
SFString userID SFString initializeOnly -1 User ID to identify the server
SFString address SFString initializeOnly Network address that sould be bound to this service
SFInt32 port SFInt32 initializeOnly 4848 Port that sould be bound to this service
SFBool autonet SFBool initializeOnly TRUE If true, allow outomatic server retrival
SFString communicationType SFString initializeOnly multicomm multicomm or multicast
SFInt32 maxEventPerFrame SFInt32 inputOutput -1 Maximum number of incomming events that should be processed in one frame. This can be used to prevent avalon from beeing blocked by external events.
SFBool sendResponse SFBool inputOutput TRUE If TRUE, a response for each incomming command is sent.
SFInt32 whiteboardMCTTL SFInt32 initializeOnly 4 TTL to be used to connect to a whiteboard with multicast. Thisdepends on the network configuration. In most cases each routersubtracts 1 from the TTL and if the number reaches 0, the package is removed.
SFInt32 networkEventLogLevel SFInt32 inputOutput 0 Log level to debug network communication. 0 is no debug output.
SFBool enabled SFBool inputOutput TRUE If TRUE, job is ready to receive and process start event
SFTime exec SFTime inputOnly This event is used to exec the job
SFTime pre SFTime outputOnly This event is triggered when the job starts
SFTime post SFTime outputOnly This event is triggered when the job is finished
SFTime runTime SFTime initializeOnly 0 Time when execution was finished
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