org.openlcb.implementations

Class MemoryConfigurationService

java.lang.Object

org.openlcb.implementations.MemoryConfigurationService

Direct Known Subclasses:

FakeMemoryConfigurationService

public class MemoryConfigurationService
extends Object

Service for reading and writing via the Memory Configuration protocol

Meant to shield the using code from all the details of that process via read and write primitives.

Can accept requests without the using code having to serialize them.

Version:

$Revision: -1 $

Author:

Bob Jacobsen Copyright 2012, David Harris Copyright 2016

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MemoryConfigurationService.AddrSpaceDatagramMemo
class	MemoryConfigurationService.ConfigDatagramMemo
private static class	MemoryConfigurationService.McsAddressedRequestMemo Common base class for all request/response memos that take a space byte and an address offset, such as read, write, read stream, write stream.
static class	MemoryConfigurationService.McsAddrSpaceMemo
static class	MemoryConfigurationService.McsConfigMemo
static interface	MemoryConfigurationService.McsReadHandler
(package private) static class	MemoryConfigurationService.McsReadMemo
private static class	MemoryConfigurationService.McsRequestMemo
static interface	MemoryConfigurationService.McsWriteHandler
(package private) static class	MemoryConfigurationService.McsWriteMemo
static class	MemoryConfigurationService.McsWriteStreamMemo
private static interface	MemoryConfigurationService.RequestWithNoReply Request memos that do not have to receive a reply datagram must implement this method in order to allow the datagram transmit OK to be forwarded back to the client.
private static interface	MemoryConfigurationService.RequestWithReplyDatagram Request memos that can receive a reply must implement this method to handle the response datagram.
class	MemoryConfigurationService.WriteStreamMemo

Field Summary

Fields

Modifier and Type	Field and Description
(package private) MemoryConfigurationService.McsAddrSpaceMemo	addrSpaceMemo
(package private) MemoryConfigurationService.McsConfigMemo	configMemo
private static int	DATAGRAM_TYPE
(package private) DatagramService	downstream
(package private) NodeID	here
private static Logger	logger
private static long	MAX_TRIES
(package private) Map<Integer,MemoryConfigurationService.McsRequestMemo>	pendingRequests
(package private) Map<Integer,ArrayDeque<MemoryConfigurationService.McsRequestMemo>>	queuedRequests
private Timer	retryTimer
static int	SPACE_ACDI_CONST
static int	SPACE_ACDI_USER
static int	SPACE_ALL_MEM
static int	SPACE_CDI
static int	SPACE_CONFIG
static int	SPACE_TRACTION_FDI
static int	SPACE_TRACTION_FUNCTION
private static int	SUBCMD_ERROR
private static int	SUBCMD_READ
private static int	SUBCMD_READ_STREAM
private static int	SUBCMD_REPLY
private static int	SUBCMD_WRITE
private static int	SUBCMD_WRITE_STREAM
private static long	TIMEOUT
private long	timeoutMillis
(package private) MemoryConfigurationService.McsWriteStreamMemo	writeStreamMemo

Constructor Summary

Constructors

Constructor and Description
MemoryConfigurationService(MemoryConfigurationService mcs)
MemoryConfigurationService(NodeID here, DatagramService downstream)

Method Summary

Modifier and Type	Method and Description
private void	checkAndPopAddrspaceMemo(MemoryConfigurationService.McsAddrSpaceMemo memo)
private void	checkAndPopConfigMemo(MemoryConfigurationService.McsConfigMemo memo)
private void	checkAndPopMemo(MemoryConfigurationService.McsRequestMemo memo) Tests if the given memo is in the top memo in pendingRequests for its request type.
private void	delayRetryMemo(MemoryConfigurationService.McsRequestMemo memo) Starts a timer and re-tries a request if the timer expired without seeing a response.
void	dispose()
static int	getRequestTypeFromResponseType(int subCmd) Computes what the request type would be that caused this response command to arrive.
static int	getSpaceFromPayload(int[] data)
private boolean	isBlockingPendingQueue(MemoryConfigurationService.McsRequestMemo memo)
void	request(MemoryConfigurationService.McsAddrSpaceMemo memo)
void	request(MemoryConfigurationService.McsConfigMemo memo)
void	request(MemoryConfigurationService.McsRequestMemo memo)
void	request(MemoryConfigurationService.McsWriteStreamMemo memo)
void	requestRead(NodeID dest, int space, long address, int len, MemoryConfigurationService.McsReadHandler cb)
void	requestWrite(NodeID dest, int space, long address, byte[] data, MemoryConfigurationService.McsWriteHandler cb)
private void	sendRequest(MemoryConfigurationService.McsRequestMemo memo)
void	setTimeoutMillis(long t)
void	waitForTimer() Waits to ensure that all pending timer tasks are complete.

Methods inherited from class java.lang.Object

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

Field Detail

logger

private static final Logger logger

DATAGRAM_TYPE

private static final int DATAGRAM_TYPE

See Also:

Constant Field Values

SPACE_CDI

public static final int SPACE_CDI

See Also:

Constant Field Values

SPACE_ALL_MEM

public static final int SPACE_ALL_MEM

See Also:

Constant Field Values

SPACE_CONFIG

public static final int SPACE_CONFIG

See Also:

Constant Field Values

SPACE_ACDI_CONST

public static final int SPACE_ACDI_CONST

See Also:

Constant Field Values

SPACE_ACDI_USER

public static final int SPACE_ACDI_USER

See Also:

Constant Field Values

SPACE_TRACTION_FDI

public static final int SPACE_TRACTION_FDI

See Also:

Constant Field Values

SPACE_TRACTION_FUNCTION

public static final int SPACE_TRACTION_FUNCTION

See Also:

Constant Field Values

SUBCMD_REPLY

private static final int SUBCMD_REPLY

See Also:

Constant Field Values

SUBCMD_ERROR

private static final int SUBCMD_ERROR

See Also:

Constant Field Values

SUBCMD_WRITE

private static final int SUBCMD_WRITE

See Also:

Constant Field Values

SUBCMD_WRITE_STREAM

private static final int SUBCMD_WRITE_STREAM

See Also:

Constant Field Values

SUBCMD_READ

private static final int SUBCMD_READ

See Also:

Constant Field Values

SUBCMD_READ_STREAM

private static final int SUBCMD_READ_STREAM

See Also:

Constant Field Values

TIMEOUT

private static final long TIMEOUT

See Also:

Constant Field Values

timeoutMillis

private long timeoutMillis

MAX_TRIES

private static final long MAX_TRIES

See Also:

Constant Field Values

here

NodeID here

downstream

DatagramService downstream

retryTimer

private Timer retryTimer

pendingRequests

final Map<Integer,MemoryConfigurationService.McsRequestMemo> pendingRequests

queuedRequests

final Map<Integer,ArrayDeque<MemoryConfigurationService.McsRequestMemo>> queuedRequests

writeStreamMemo

MemoryConfigurationService.McsWriteStreamMemo writeStreamMemo

configMemo

MemoryConfigurationService.McsConfigMemo configMemo

addrSpaceMemo

MemoryConfigurationService.McsAddrSpaceMemo addrSpaceMemo

Constructor Detail

MemoryConfigurationService

public MemoryConfigurationService(NodeID here,
                                  DatagramService downstream)

Parameters:

here - our node ID

downstream - Connection in the direction of the layout

MemoryConfigurationService

public MemoryConfigurationService(MemoryConfigurationService mcs)

Method Detail

setTimeoutMillis

public void setTimeoutMillis(long t)

waitForTimer

public void waitForTimer()
                  throws InterruptedException

Waits to ensure that all pending timer tasks are complete. Used for testing.

Throws:

InterruptedException - if interrupted

getSpaceFromPayload

public static int getSpaceFromPayload(int[] data)

getRequestTypeFromResponseType

public static int getRequestTypeFromResponseType(int subCmd)

Computes what the request type would be that caused this response command to arrive.

Parameters:

subCmd - data[1] of an incoming response.

Returns:

data[1] (minus the space)

checkAndPopMemo

private void checkAndPopMemo(MemoryConfigurationService.McsRequestMemo memo)

Tests if the given memo is in the top memo in pendingRequests for its request type. If so, pops it.

Parameters:

memo - the memo to test.

isBlockingPendingQueue

private boolean isBlockingPendingQueue(MemoryConfigurationService.McsRequestMemo memo)

Parameters:

memo - a request memo

Returns:

true if this request memo is already sent, but no response or failure has been received, i.e. this memo is blocking the pending queue.

delayRetryMemo

private void delayRetryMemo(MemoryConfigurationService.McsRequestMemo memo)

Starts a timer and re-tries a request if the timer expired without seeing a response.

Parameters:

memo - request memo with expected response.

sendRequest

private void sendRequest(MemoryConfigurationService.McsRequestMemo memo)

request

public void request(MemoryConfigurationService.McsRequestMemo memo)

requestWrite

public void requestWrite(NodeID dest,
                         int space,
                         long address,
                         byte[] data,
                         MemoryConfigurationService.McsWriteHandler cb)

requestRead

public void requestRead(NodeID dest,
                        int space,
                        long address,
                        int len,
                        MemoryConfigurationService.McsReadHandler cb)

request

public void request(MemoryConfigurationService.McsWriteStreamMemo memo)

request

public void request(MemoryConfigurationService.McsConfigMemo memo)

request

public void request(MemoryConfigurationService.McsAddrSpaceMemo memo)

checkAndPopConfigMemo

private void checkAndPopConfigMemo(MemoryConfigurationService.McsConfigMemo memo)

checkAndPopAddrspaceMemo

private void checkAndPopAddrspaceMemo(MemoryConfigurationService.McsAddrSpaceMemo memo)

dispose

public void dispose()