com.adobe.cq.screens

Interface DeviceMessageQueue

public interface DeviceMessageQueue

The device message queue allows to queue messages unidirectional to the devices

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	DeviceMessageQueue.Entry Entry that can be added to the queue.
static interface	DeviceMessageQueue.EntryBuilder Builder for device message queue entries.

Method Summary

Modifier and Type	Method and Description
DeviceMessageQueue.EntryBuilder	createEntryBuilder(String message) Creates a new device message queue entry builder with the given message.
String	dequeue(String path) Dequeue message
DeviceMessageQueue.Entry	dequeueEntry(String path) Dequeue message and payload
void	queue(String path, String message) Queue message
void	queueEntry(String path, DeviceMessageQueue.Entry entry) Queue message and payload

Method Detail

queueEntry

void queueEntry(String path,
                DeviceMessageQueue.Entry entry)

Queue message and payload

Parameters:

path - The path of the resource that this message belongs.

entry - The message queue entry.

dequeueEntry

DeviceMessageQueue.Entry dequeueEntry(String path)

Dequeue message and payload

Parameters:

path - The path of the resource that this message belongs.

Returns:

the next entry or null if the queue is empty.

createEntryBuilder

DeviceMessageQueue.EntryBuilder createEntryBuilder(String message)

Creates a new device message queue entry builder with the given message.

Parameters:

message - the message for the entry.

Returns:

the builder.

queue

void queue(String path,
           String message)

Queue message

Parameters:

path - The path of the resource that this message belongs.

message - A simple message with no payload.

dequeue

String dequeue(String path)

Dequeue message

Parameters:

path - The path of the resource that this message belongs.

Returns:

the next message or null if the queue is empty.