instantreality 1.0

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

WebInterfaceJob

The WebInterfaceJob provides an interface to verify and modify fields of the scene by using a Web Browser.

Inheritance

Code

XML encoding
<WebInterfaceJob runTime='0'
logFeature=''
hostnameLookups='FALSE'
enabled='TRUE'
maxKeepAliveRequests='100'
keepAliveTimeout='15'
networkEventLogLevel='0'
maxClients='256'
timeOut='300'
appUrl=''
stylePageUrl=''
logPageEntries='25'
user=''
passwd=''
realm='Avalon'
address=''
port='35668'
backlog='511'
triggerName='WebInterface'
 />
Classic encoding
WebInterfaceJob {
	runTime 0
	logFeature [""]
	hostnameLookups FALSE
	enabled TRUE
	maxKeepAliveRequests 100
	keepAliveTimeout 15
	networkEventLogLevel 0
	maxClients 256
	timeOut 300
	appUrl [""]
	stylePageUrl [""]
	logPageEntries 25
	user ""
	passwd ""
	realm "Avalon"
	address ""
	port 35668
	backlog 511
	triggerName "WebInterface"
}

Interface

Filter: X3D only | Avalon only | All
id Name DataType PartType Default ValueType Description
SFString address SFString initializeOnly Address to which this service should be bound
MFString appUrl MFString initializeOnly Documents that should be available through the web interface
SFInt32 backlog SFInt32 initializeOnly 511 Number of messages that should be logged internally
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
SFBool hostnameLookups SFBool initializeOnly FALSE If true, hostname lookups are allowed, i.e. the real host names are written into the log. If false, only the IP adresses are written into the log.
SFInt32 keepAliveTimeout SFInt32 initializeOnly 15 Timeout between subsequent request when a connection is kept open.
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 logPageEntries SFInt32 inputOutput 25 Number of entries in the log page
SFInt32 maxClients SFInt32 initializeOnly 256 Maximum number of clients that are able to simultaniously connect to the web server
SFInt32 maxKeepAliveRequests SFInt32 initializeOnly 100 Maximum number of requests that can be sent on an open connection before the connection gets closed
SFNode metadata SFNode inputOutput MetadataObject container for payload metadata inside MetadataSet element
SFInt32 networkEventLogLevel SFInt32 inputOutput 0 Log level for the network layer
SFString passwd SFString initializeOnly Password. Can be used to force user identification
SFInt32 port SFInt32 initializeOnly 35668 Port number the web server listens at for web browsers
SFTime post SFTime outputOnly This event is triggered when the job is finished
SFTime pre SFTime outputOnly This event is triggered when the job starts
SFString realm SFString initializeOnly Avalon This field is used in conjunction with the user and the password field. It specifies a realm where the user names and passwords are valid. In this realm you only have to enter user name and password once at the beginning of the session. For all following requests in the same realm, the web browser automatically provides username and password.
SFTime runTime SFTime initializeOnly 0 Time when execution was finished
MFString stylePageUrl MFString initializeOnly external stylePage
SFInt32 timeOut SFInt32 initializeOnly 300 Time out for the first request. A connection is closed when the web browser does not send the first request in this period of time.
SFString triggerName SFString initializeOnly WebInterface 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.
SFString user SFString initializeOnly User name. Can be used to force user identification.