org.ka2ddo.yaac.ax25

Class MsgEventDispatcher

java.lang.Object

org.ka2ddo.yaac.ax25.MsgEventDispatcher

public class MsgEventDispatcher
extends java.lang.Object

This singleton class provides a dispatcher of events of type MsgEventType. Listeners can register here to be informed of events.

Since:

PROVIDER_API_VERSION == 7

Author:

Andrew Pavlin, KA2DDO

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MsgEventDispatcher.QueuedMsgEvent Helper class for queuing events that can't be fired immediately (perhaps because they were detected while in mutex-synchronized code).

Method Summary

Modifier and Type	Method and Description
static void	addMsgEventListener(MsgEventListener l) Register the specified listener for all types of events.
static void	addMsgEventListener(MsgEventListener l, MsgEventType... types) Register the specified listener for all types of events.
static void	fireMsgEvent(MsgEventType type, StationState ss, AX25Message msg, java.lang.String text, java.lang.Object other) Notify all interested MsgEventListeners about an event.
static void	removeMsgEventListener(MsgEventListener l) Unregister a MsgEventListener.

Methods inherited from class java.lang.Object

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

Method Detail

addMsgEventListener

public static void addMsgEventListener(MsgEventListener l)

Register the specified listener for all types of events. Note that if the listener is already registered, its registration will remain unchanged; the types will not be altered.

Parameters:

l - MsgEventListener to register

addMsgEventListener

public static void addMsgEventListener(MsgEventListener l,
                                       MsgEventType... types)

Register the specified listener for all types of events. Note that if the listener is already registered, its registration will remain unchanged; the types will not be altered.

Parameters:

l - MsgEventListener to register

types - MsgEventTypes to be reported; types not matching this list will not be reported to this particular listener

removeMsgEventListener

public static void removeMsgEventListener(MsgEventListener l)

Unregister a MsgEventListener.

Parameters:

l - MsgEventListener to remove

fireMsgEvent

public static void fireMsgEvent(MsgEventType type,
                                StationState ss,
                                AX25Message msg,
                                java.lang.String text,
                                java.lang.Object other)

Notify all interested MsgEventListeners about an event.

Parameters:

type - MsgEventType of event

ss - StationState associated with event

msg - AX25Message associated with event

text - String associated with event

other - Object of some other class associated with the event