app.spa

Class SPAEventStreamChannel

java.lang.Object

app.spa.SPAEventStreamChannel

All Implemented Interfaces:

SPAEventStreamSource, SPAEventTarget

public class SPAEventStreamChannel
extends java.lang.Object
implements SPAEventTarget, SPAEventStreamSource

Synchronous SPA event stream channel, acting both as a SPAEventTarget and as a SPAEventStreamSource. This is effectively a zero-slot channel connecting one or more event source(s) (clients) to a single event target (server): a new event cannot be accepted (via the channel's SPAEventTarget implementation) before the acknowledgement for its predecessor has been delivered (via the channel's SPAEventStreamSource implementation).

Constructor Summary

Constructors

Constructor and Description
SPAEventStreamChannel(UseJLogger lggr) Constructs a new event channel, using the given logger.

Method Summary

Modifier and Type	Method and Description
void	deliverAck(SPAEventAck ack) Delivers the given acknowledgement in response to the most recently obtained player event.
void	deliverAck(java.lang.String ackmsg) Delivers a new failure acknowledgement with the given descriptive text.
void	deliverOKAck() Delivers an OK acknowledgement.
SPAEvent	getNextEvent() Obtains and returns the most recently posted player event, blocking if necessary until it becomes available.
SPAEventAck	postEvent(EventId eid) Posts a new event with the given id to this channel, blocking if necessary until it is ready to accept it, before obtaining and returning the corresponding acknowledgment.
SPAEventAck	postEvent(SPAEvent evt) Posts the given event to this channel, blocking if necessary until it is ready to accept it, before obtaining and returning the corresponding acknowledgment.

Methods inherited from class java.lang.Object

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

Constructor Detail

SPAEventStreamChannel

public SPAEventStreamChannel(UseJLogger lggr)

Constructs a new event channel, using the given logger.

Method Detail

postEvent

public SPAEventAck postEvent(SPAEvent evt)

Posts the given event to this channel, blocking if necessary until it is ready to accept it, before obtaining and returning the corresponding acknowledgment.

Specified by:

postEvent in interface SPAEventTarget

postEvent

public SPAEventAck postEvent(EventId eid)

Posts a new event with the given id to this channel, blocking if necessary until it is ready to accept it, before obtaining and returning the corresponding acknowledgment.

Specified by:

postEvent in interface SPAEventTarget

getNextEvent

public SPAEvent getNextEvent()
                      throws java.lang.InterruptedException

Obtains and returns the most recently posted player event, blocking if necessary until it becomes available.

Specified by:

getNextEvent in interface SPAEventStreamSource

Throws:

java.lang.InterruptedException

deliverAck

public void deliverAck(SPAEventAck ack)
                throws java.lang.InterruptedException

Delivers the given acknowledgement in response to the most recently obtained player event.

Specified by:

deliverAck in interface SPAEventStreamSource

Throws:

java.lang.InterruptedException

deliverOKAck

public void deliverOKAck()
                  throws java.lang.InterruptedException

Delivers an OK acknowledgement.

Specified by:

deliverOKAck in interface SPAEventStreamSource

Throws:

java.lang.InterruptedException

deliverAck

public void deliverAck(java.lang.String ackmsg)
                throws java.lang.InterruptedException

Delivers a new failure acknowledgement with the given descriptive text.

Specified by:

deliverAck in interface SPAEventStreamSource

Throws:

java.lang.InterruptedException