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 |
|---|---|---|---|---|---|---|
 |
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 | |
 |
autonet | SFBool | initializeOnly | TRUE | If true, allow outomatic server retrival | |
|
enabled | SFBool | inputOutput | TRUE | If TRUE, job is ready to receive and process start event | |
|
sendResponse | SFBool | inputOutput | TRUE | If TRUE, a response for each incomming command is sent. | |
 |
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. | |
|
netID | SFInt32 | initializeOnly | 0 | Network ID to identify the server | |
|
networkEventLogLevel | SFInt32 | inputOutput | 0 | Log level to debug network communication. 0 is no debug output. | |
|
port | SFInt32 | initializeOnly | 4848 | Port that sould be bound to this service | |
|
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. | |
 |
metadata | SFNode | inputOutput | MetadataObject | container for payload metadata inside MetadataSet element | |
 |
address | SFString | initializeOnly | Network address that sould be bound to this service | ||
|
communicationType | SFString | initializeOnly | multicomm | multicomm or multicast | |
|
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. | |
|
userID | SFString | initializeOnly | -1 | User ID to identify the server | |
 |
exec | SFTime | inputOnly | This event is used to exec the job | ||
|
post | SFTime | outputOnly | This event is triggered when the job is finished | ||
|
pre | SFTime | outputOnly | This event is triggered when the job starts | ||
|
runTime | SFTime | initializeOnly | 0 | Time when execution was finished |