QueueUtils
Inclusion code:
| Service Deployment | |||
|---|---|---|---|
| Port Name | Location | Protocol | Interfaces |
| QueueUtils documentation: | |||
| QueueUtils | - | - | QueueUtilsInterface |
List of Available Interfaces
QueueUtilsInterface
Interface documentation:
| Operation Name | Input Type | Output Type | Faults |
|---|---|---|---|
| size | string | int | |
| poll | string | undefined | |
| new_queue | string | bool | |
| delete_queue | string | bool | |
| push | QueueRequest | bool | |
| peek | string | undefined |
Operation Description
size
Operation documentation: Returns the size of an existing queue, null otherwise
Invocation template:
size@QueueUtils( request )( response )
Request type
Type: string
string : string
Response type
Type: int
int : int
poll
Operation documentation: Removes and returns the head of the queue
Invocation template:
poll@QueueUtils( request )( response )
Request type
Type: string
string : string
Response type
Type: undefined
undefined : any
new_queue
Operation documentation: Creates a new queue with queue_name as key
Invocation template:
new_queue@QueueUtils( request )( response )
Request type
Type: string
string : string
Response type
Type: bool
bool : bool
delete_queue
Operation documentation: Removes an existing queue
Invocation template:
delete_queue@QueueUtils( request )( response )
Request type
Type: string
string : string
Response type
Type: bool
bool : bool
push
Operation documentation: Pushes an element at the end of an existing queue
Invocation template:
push@QueueUtils( request )( response )
Request type
Type: QueueRequest
type QueueRequest: void {
.queue_name: string
.element: undefined
}
QueueRequest : void
queue_name : stringelement : any
Response type
Type: bool
bool : bool
peek
Operation documentation: Retrieves, but does not remove, the head of the queue
Invocation template:
peek@QueueUtils( request )( response )
Request type
Type: string
string : string
Response type
Type: undefined
undefined : any