Console

Inclusion code:

Service Deployment
Port Name Location Protocol Interfaces
ConsoleInputPort local - ConsoleInputInterface
Console documentation:
Console - - ConsoleInterface

List of Available Interfaces

ConsoleInputInterface

Interface documentation:

Operation Name Input Type Output Type Faults
in InRequest -

Operation Description

in

Operation documentation:

Invocation template:

in( request )

Request type

Type: InRequest

type InRequest: string {
    .token?: string
}

InRequest : string

  • token : string

ConsoleInterface

Interface documentation:

Operation Name Input Type Output Type Faults
print undefined void
println undefined void
registerForInput RegisterForInputRequest void
unsubscribeSessionListener UnsubscribeSessionListener void
subscribeSessionListener SubscribeSessionListener void
enableTimestamp EnableTimestampRequest void

Operation Description

Operation documentation:

Invocation template:

print@Console( request )( response )

Request type

Type: undefined

undefined : any

Response type

Type: void

void : void

println

Operation documentation:

Invocation template:

println@Console( request )( response )

Request type

Type: undefined

undefined : any

Response type

Type: void

void : void

registerForInput

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

Invocation template:

registerForInput@Console( request )( response )

Request type

Type: RegisterForInputRequest

type RegisterForInputRequest: void {
    .enableSessionListener?: bool
}

RegisterForInputRequest : void

  • enableSessionListener : bool

Response type

Type: void

void : void

unsubscribeSessionListener

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

Invocation template:

unsubscribeSessionListener@Console( request )( response )

Request type

Type: UnsubscribeSessionListener

type UnsubscribeSessionListener: void {
    .token: string
}

UnsubscribeSessionListener : void

  • token : string

Response type

Type: void

void : void

subscribeSessionListener

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

Invocation template:

subscribeSessionListener@Console( request )( response )

Request type

Type: SubscribeSessionListener

type SubscribeSessionListener: void {
    .token: string
}

SubscribeSessionListener : void

  • token : string

Response type

Type: void

void : void

enableTimestamp

Operation documentation: 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.

Invocation template:

enableTimestamp@Console( request )( response )

Request type

Type: EnableTimestampRequest

type EnableTimestampRequest: bool {
    .format?: string
}

EnableTimestampRequest : bool

  • format : string

Response type

Type: void

void : void

results matching ""

    No results matching ""