Package net.solarnetwork.ocpp.service

Class SimpleActionMessageQueue

java.lang.Object

net.solarnetwork.ocpp.service.SimpleActionMessageQueue

All Implemented Interfaces:

ActionMessageQueue

public class SimpleActionMessageQueue
extends Object
implements ActionMessageQueue

Simple in-memory implementation of ActionMessageQueue.

Version:

1.0

Author:

matt

Constructor Summary

Constructors

Constructor	Description
SimpleActionMessageQueue()	Constructor.
SimpleActionMessageQueue(Map<ChargePointIdentity,Deque<PendingActionMessage>> pendingMessages)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	addPendingMessage(PendingActionMessage msg, Consumer<Deque<PendingActionMessage>> fn)	Add a message to the pending message queue.
Iterable<Map.Entry<ChargePointIdentity,Deque<PendingActionMessage>>>	allQueues()	Get an iterable for all available queues.
Deque<PendingActionMessage>	pendingMessageQueue(ChargePointIdentity clientId)	Get the pending message queue for a specific client.
PendingActionMessage	pollPendingMessage(ChargePointIdentity clientId)	Find and remove the first available message from the pending message queue.
PendingActionMessage	pollPendingMessage(ChargePointIdentity clientId, String messageId)	Find and remove a message from the pending message queue, based on its message ID.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface net.solarnetwork.ocpp.service.ActionMessageQueue

addPendingMessage

Constructor Details

SimpleActionMessageQueue

public SimpleActionMessageQueue()

Constructor.

SimpleActionMessageQueue

public SimpleActionMessageQueue(Map<ChargePointIdentity,Deque<PendingActionMessage>> pendingMessages)

Constructor.

Parameters:

pendingMessages - the pending message queue map

Method Details

pendingMessageQueue

public Deque<PendingActionMessage> pendingMessageQueue(ChargePointIdentity clientId)

Description copied from interface: ActionMessageQueue

Get the pending message queue for a specific client.

Specified by:

pendingMessageQueue in interface ActionMessageQueue

Parameters:

clientId - the client ID

Returns:

the queue, never null

addPendingMessage

public void addPendingMessage(PendingActionMessage msg,
 Consumer<Deque<PendingActionMessage>> fn)

Description copied from interface: ActionMessageQueue

Add a message to the pending message queue.

The pending message's ActionMessage.getClientId() will determine the client queue the message is added to.

Specified by:

addPendingMessage in interface ActionMessageQueue

Parameters:

msg - the message to add

fn - an optional function to apply synchronously

pollPendingMessage

public PendingActionMessage pollPendingMessage(ChargePointIdentity clientId)

Description copied from interface: ActionMessageQueue

Find and remove the first available message from the pending message queue.

Specified by:

pollPendingMessage in interface ActionMessageQueue

Parameters:

clientId - the ID of the client

Returns:

the found message, or null if no messages available

pollPendingMessage

public PendingActionMessage pollPendingMessage(ChargePointIdentity clientId,
 String messageId)

Description copied from interface: ActionMessageQueue

Find and remove a message from the pending message queue, based on its message ID.

This method will search the pending messages queue and return the first message found with the matching message ID, after first removing that message from the queue.

Specified by:

pollPendingMessage in interface ActionMessageQueue

Parameters:

clientId - the ID of the client

messageId - the ID to find

Returns:

the found message, or null if not found

allQueues

public Iterable<Map.Entry<ChargePointIdentity,Deque<PendingActionMessage>>> allQueues()

Description copied from interface: ActionMessageQueue

Get an iterable for all available queues.

Specified by:

allQueues in interface ActionMessageQueue

Returns:

the iterable, never null