JolieDoc for Port Console

From file console.iol

Port Name Location Protocol
Console

List of the available interfaces


Interface ConsoleInterface

Heading Input type Output type Faults
enableTimestamp EnableTimestampRequest
void
print undefined
void
println undefined
void
registerForInput RegisterForInputRequest
void
subscribeSessionListener SubscribeSessionListener
void
unsubscribeSessionListener UnsubscribeSessionListener
void

Operation list

print

print( undefined )( void )

println

println( undefined )( void )

registerForInput

registerForInput( RegisterForInputRequest )( void )

it enables the console for input listening
parameter enableSessionListener enables console input listening for more than one service session (default=false)

unsubscribeSessionListener

unsubscribeSessionListener( UnsubscribeSessionListener )( void )

it disables a session to receive inputs from the console, previously registered with subscribeSessionListener operation

subscribeSessionListener

subscribeSessionListener( SubscribeSessionListener )( void )

it receives a token string which identifies a service session.
it enables the session to receive inputs from the console

enableTimestamp

enableTimestamp( EnableTimestampRequest )( void )

It enables timestamp inline printing for each console output operation call: print, println
Parameter format allows to specifiy the timestamp output format. Bad Format will be printed out if format value is not allowed.


Message type list

RegisterForInputRequest

type RegisterForInputRequest: void { 
    .enableSessionListener?: bool
}

UnsubscribeSessionListener

type UnsubscribeSessionListener: void { 
    .token: string
}

SubscribeSessionListener

type SubscribeSessionListener: void { 
    .token: string
}

EnableTimestampRequest

type EnableTimestampRequest: bool { 
    .format?: string
}

Type list

results matching ""

    No results matching ""