org.vishia.msgDispatch

Class MsgDispatcherCore

java.lang.Object

org.vishia.msgDispatch.LogMessageBase

org.vishia.msgDispatch.MsgDispatcherCore

All Implemented Interfaces:

java.lang.Appendable, LogMessage

Direct Known Subclasses:

MsgDispatcher

public class MsgDispatcherCore
extends LogMessageBase

This is the core of the message dispatcher. It dispatches only. The dispatch table maybe filled with a simplest algorithm. This class is able to use in a simple environment.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MsgDispatcherCore.Entry Stores all data of a message if the message is queued here.
protected static class	MsgDispatcherCore.Output This class contains all infomations for a output.
protected static class	MsgDispatcherCore.TestCnt This class contains some test-counts for debugging.

Field Summary

Fields

Modifier and Type	Field and Description
protected int	actNrofListIdents List of idents, its current length.
(package private) int	ctLostMessages
protected MsgDispatcherCore.Entry	entryMsgBufferOverflow
(package private) ConcurrentLinkedQueue<MsgDispatcherCore.Entry>	freeOrders List of entries for messages to use.
(package private) long	idThreadForDispatching
protected int[]	listBitDst List of destination bits for the idents.
protected int[]	listIdents List of idents, a array with lengthListIdents elements.
(package private) ConcurrentLinkedQueue<MsgDispatcherCore.Entry>	listOrders List of messages to process in the dispatcher thread.
static int	mAdd Used for argument mode from #setOutputRange(int, int, int, int, int) to add an output.
static int	mConsole Mask for dispatch the message to console directly in the calling thread.
static int	mConsoleQueued queued Console output, it is a fix part of the Message dispatcher.
static int	mDispatchBits Only this bits are used to indicate the destination via some Bits
static int	mDispatchInCallingThread If this bit is set in the bitmask for dispatching, the dispatching should only be done in the calling thread.
static int	mDispatchInDispatcherThread If this bit is set in the bitmask for dispatching, the dispatching should be done in the dispatcher Thread.
int	mDstMixedOutputs Calculated mask of bits which are able to mix.
int	mDstOneOutput Calculated mask of bits which are one index.
static int	mRemove Used for argument mode from #setOutputRange(int, int, int, int, int) to remove an output.
static int	mSet Used for argument mode from #setOutputRange(int, int, int, int, int) to set an output.
protected MsgText_ifc	msgText Converter from the ident number to a text.
protected int	nrofMixedOutputs Number of Bits in mDispatchWithBits, it is the number of destinations dispatched via bit mask.
protected MsgDispatcherCore.Output[]	outputs up to 30 destinations for output.
protected java.lang.Runnable	runNoEntryMessage
(package private) MsgDispatcherCore.TestCnt	testCnt
static int	version version, history and license.

Fields inherited from class org.vishia.msgDispatch.LogMessageBase

nLogLevel

Fields inherited from interface org.vishia.msgDispatch.LogMessage

dateFormat, debug, error, fineDebug, fineInfo, info, minSecondsFormat, mNeverOutputToDisplay, mReportLevel, sVersion, warning

Constructor Summary

Constructors

Constructor and Description
MsgDispatcherCore(int maxQueue, int nrofMixedOutputs, java.lang.Runnable runNoEntryMessage) Initializes the instance.

Method Summary

Modifier and Type	Method and Description
java.lang.Appendable	append(char c) This is more formally, only one char is nonsense for the MsgDispatcher.
java.lang.Appendable	append(java.lang.CharSequence csq) TODO yet message nr 0 is created, get the message from the start text...
java.lang.Appendable	append(java.lang.CharSequence csq, int start, int end)
void	close() This routine may be overridden by the inherited class (usual MsgDispatcher to support closing.
protected int	dispatchMsg(int dstBits, boolean bDispatchInDispatcherThread, boolean bDispatchAlways, int identNumber, OS_TimeStamp creationTime, java.lang.CharSequence text, Va_list args) Dispatches a message.
int	dispatchQueuedMsg() Dispatches all messages, which are stored in the queue.
void	flush() This routine may be overridden by the inherited class (usual MsgDispatcher to support flushing all queued messages.
boolean	isOnline() Checks whether the message output is available.
int	searchDispatchBits(int ident) Searches and returns the bits where a message is dispatch to.
boolean	sendMsg(int identNumber, java.lang.CharSequence text, java.lang.Object... args) Sends a message.
boolean	sendMsgTime(int identNumber, OS_TimeStamp creationTime, java.lang.CharSequence text, java.lang.Object... args) Sends a message.
boolean	sendMsgVaList(int identNumber, OS_TimeStamp creationTime, java.lang.CharSequence text, Va_list args) Sends a message.
void	setIdThreadForMsgDispatching(long idThread) Sets the capability that messages which are create in the dispatcher thread are output immediately though the output channel should be used in the dispatcher thread.
void	setMsgTextConverter(MsgText_ifc converter)
void	tickAndFlushOrClose() Dispatches the queues messages, after them calls LogMessage.flush() for all queued outputs.

Methods inherited from class org.vishia.msgDispatch.LogMessageBase

flushReport, getReportLevel, getReportLevelFromIdent, report, report, reportln, reportln, setReportLevel, setReportLevelToIdent, writeError, writeError, writeInfo, writeInfoln, writeWarning

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.vishia.msgDispatch.LogMessage

msgSec, timeCurr, timeMsg

Field Detail

version

public static final int version

version, history and license.

• 2014-01-08 Hartmut new: setIdThreadForMsgDispatching(long)
• 2014-01-08 Hartmut chg: The tickAndFlushOrClose() should be part of the core.
• 2013-03-02 Hartmut chg: The LogMessage is implemented here now, instead in the derived MsgDispatcher.
• 2013-02-25 Hartmut new: The MsgDispatcherCore.Output.bUseText stores whether the output channel uses the text. The #dispatchMsg(int, boolean, int, OS_TimeStamp, String, Va_list) gets a text from configuration only if it is need.
• 2013-02-25 Hartmut new: The #sendMsgVaList(int, OS_TimeStamp, String, Va_list) counts whether a message can't be queued. it is used to output a 'lostmessage' message in dispatchQueuedMsg().
• 2012-08-22 Hartmut new setMsgTextConverter(MsgText_ifc). It provides a possibility to work with a translation from ident numbers to text with an extra module, it is optional.
• 2012-06-15 Hartmut created as separation from the MsgDispatcher because it may necessary to deploy in a small C environment.

Copyright/Copyleft: For this source the LGPL Lesser General Public License, published by the Free Software Foundation is valid. It means:

1. You can use this source without any restriction for any desired purpose.
2. You can redistribute copies of this source to everybody.
3. Every user of this source, also the user of redistribute copies with or without payment, must accept this license for further using.
4. But the LPGL ist not appropriate for a whole software product, if this source is only a part of them. It means, the user must publish this part of source, but don't need to publish the whole source of the own product.
5. You can study and modify (improve) this source for own using or for redistribution, but you have to license the modified sources likewise under this LGPL Lesser General Public License. You mustn't delete this Copyright/Copyleft inscription in this source file.

If you are intent to use this sources without publishing its usage, you can get a second license subscribing a special contract with the author.

See Also:

Constant Field Values

mDispatchInDispatcherThread

public static final int mDispatchInDispatcherThread

If this bit is set in the bitmask for dispatching, the dispatching should be done in the dispatcher Thread. In the calling thread the message is stored in a queue.

See Also:

Constant Field Values

mDispatchInCallingThread

public static final int mDispatchInCallingThread

If this bit is set in the bitmask for dispatching, the dispatching should only be done in the calling thread. It is possible that also the bit mDispatchInDispatcherThread is set, if there is more as one destination.

See Also:

Constant Field Values

mDispatchBits

public static final int mDispatchBits

Only this bits are used to indicate the destination via some Bits

See Also:

Constant Field Values

nrofMixedOutputs

protected final int nrofMixedOutputs

Number of Bits in mDispatchWithBits, it is the number of destinations dispatched via bit mask.

mDstMixedOutputs

public final int mDstMixedOutputs

Calculated mask of bits which are able to mix.

mDstOneOutput

public final int mDstOneOutput

Calculated mask of bits which are one index.

mConsole

public static final int mConsole

Mask for dispatch the message to console directly in the calling thread. It is like system.out.println(...) respectively printf in C. The console output is a fix part of the Message dispatcher.

See Also:

Constant Field Values

mConsoleQueued

public static final int mConsoleQueued

queued Console output, it is a fix part of the Message dispatcher.

See Also:

Constant Field Values

mAdd

public static final int mAdd

Used for argument mode from #setOutputRange(int, int, int, int, int) to add an output. The other set outputs aren't change.

See Also:

Constant Field Values

mSet

public static final int mSet

Used for argument mode from #setOutputRange(int, int, int, int, int) to set an output. Outputs before are removed.

See Also:

Constant Field Values

mRemove

public static final int mRemove

Used for argument mode from #setOutputRange(int, int, int, int, int) to remove an output. All other outputs aren't change.

See Also:

Constant Field Values

idThreadForDispatching

long idThreadForDispatching

testCnt

final MsgDispatcherCore.TestCnt testCnt

listOrders

final ConcurrentLinkedQueue<MsgDispatcherCore.Entry> listOrders

List of messages to process in the dispatcher thread.

freeOrders

final ConcurrentLinkedQueue<MsgDispatcherCore.Entry> freeOrders

List of entries for messages to use. For C usage it is a List with a fix size. The ConcurrentLinkedQueue may be implemented in a simple way if only a simplest system is used.

entryMsgBufferOverflow

protected final MsgDispatcherCore.Entry entryMsgBufferOverflow

actNrofListIdents

protected int actNrofListIdents

List of idents, its current length.

listIdents

protected int[] listIdents

List of idents, a array with lengthListIdents elements.

listBitDst

protected int[] listBitDst

List of destination bits for the idents.

outputs

protected MsgDispatcherCore.Output[] outputs

up to 30 destinations for output.

msgText

protected MsgText_ifc msgText

Converter from the ident number to a text. Maybe null, then unused. See setMsgTextConverter(MsgText_ifc)

runNoEntryMessage

protected final java.lang.Runnable runNoEntryMessage

ctLostMessages

int ctLostMessages

Constructor Detail

MsgDispatcherCore

MsgDispatcherCore(int maxQueue,
                  int nrofMixedOutputs,
                  java.lang.Runnable runNoEntryMessage)

Initializes the instance.

Parameters:

maxQueue - The static limited maximal size of the queue to store messages from user threads to dispatch in the dispatcher thread. If you call the dispatching in dispatcher thread cyclicly in 100-ms-steps, and you have worst case no more as 200 messages in this time, 200 is okay.

nrofMixedOutputs -

Method Detail

setIdThreadForMsgDispatching

public void setIdThreadForMsgDispatching(long idThread)

Sets the capability that messages which are create in the dispatcher thread are output immediately though the output channel should be used in the dispatcher thread. The advantage of that capability is given

• Especially on startup for messages of startup. Often the tickAndFlushOrClose() is started after continue the startup routine but in the same main thread. The startup messages should be seen without delay, especially on problems on startup.
• If some algorithm are done in a main thread, which dispatches the messages too. Then no ressources to store message entries are necessary, and the messages comes out immediately, helpfull on debugging. It may be typically that algorithm of calculation are executed in the same thread like dispatching.

Parameters:

idThread - It should be that thread id of the Thread which runs tickAndFlushOrClose().

setMsgTextConverter

public final void setMsgTextConverter(MsgText_ifc converter)

searchDispatchBits

public final int searchDispatchBits(int ident)

Searches and returns the bits where a message is dispatch to. The return value describes what to do with the message.

Parameters:

ident - The message identificator

Returns:

0 if the message should not be dispatched, else some bits or number, see mDstMixedOutputs etc.

sendMsg

public final boolean sendMsg(int identNumber,
                             java.lang.CharSequence text,
                             java.lang.Object... args)

Sends a message. See interface.

Parameters:

identNumber -

text - The text representation of the message, format string, see java.lang.String.format(..).

args - see interface

Returns:

true if the message will be dispatched, false if it is suppressed

sendMsgTime

public final boolean sendMsgTime(int identNumber,
                                 OS_TimeStamp creationTime,
                                 java.lang.CharSequence text,
                                 java.lang.Object... args)

Sends a message. See interface.

Parameters:

identNumber -

text - The text representation of the message, format string, see java.lang.String.format(..).

args - see interface

creationTime - absolute time stamp. @Java2C=perValue.

Returns:

true if the message will be dispatched, false if it is suppressed

sendMsgVaList

public final boolean sendMsgVaList(int identNumber,
                                   OS_TimeStamp creationTime,
                                   java.lang.CharSequence text,
                                   Va_list args)

Sends a message. See interface.

Parameters:

identNumber -

creationTime -

text - The identifier text @pjava2c=zeroTermString.

typeArgs - Type chars, ZCBSIJFD for boolean, char, byte, short, int, long, float double.

args - see interface

Returns:

true than okay. It is possible, that a destination for dispatching is not available yet. Than the routine returns false. That is for special outputs of message dispatcher. Normally the user shouldn't realize false here and react anywise. If a message isn't able to transport, it is not visible in the creating thread. It is possible that a message is lost anywhere in transportation way. In Generally, to secure a complex systems functionality, any timeouts, repeats and backup strategies are necessary in the supervise software above sending a single message.

append

public java.lang.Appendable append(java.lang.CharSequence csq)
                            throws java.io.IOException

TODO yet message nr 0 is created, get the message from the start text... since 2022-09 because enhancement of LogMessage with Appendable.

Throws:

java.io.IOException

append

public java.lang.Appendable append(java.lang.CharSequence csq,
                                   int start,
                                   int end)
                            throws java.io.IOException

Throws:

java.io.IOException

append

public java.lang.Appendable append(char c)
                            throws java.io.IOException

This is more formally, only one char is nonsense for the MsgDispatcher.

Throws:

java.io.IOException

isOnline

public final boolean isOnline()

Description copied from interface: LogMessage

Checks whether the message output is available.

close

public void close()

This routine may be overridden by the inherited class (usual MsgDispatcher to support closing.

See Also:

LogMessage.close()

flush

public void flush()

This routine may be overridden by the inherited class (usual MsgDispatcher to support flushing all queued messages.

See Also:

LogMessage.close()

tickAndFlushOrClose

public final void tickAndFlushOrClose()

Dispatches the queues messages, after them calls LogMessage.flush() for all queued outputs. This method can be called in any user thread cyclically. As opposite the DispatcherThread can be instantiate and DispatcherThread#start(). That thread calls only this routine in its cycle.

dispatchQueuedMsg

public final int dispatchQueuedMsg()

Dispatches all messages, which are stored in the queue. This routine should be called in a user thread or maybe in the background loop respectively the main thread. This routine is called in tickAndFlushOrClose() and in @ flush() and link #close()}.

Returns:

number of messages which are found to dispatch, for statistic use.

dispatchMsg

protected final int dispatchMsg(int dstBits,
                                boolean bDispatchInDispatcherThread,
                                boolean bDispatchAlways,
                                int identNumber,
                                OS_TimeStamp creationTime,
                                java.lang.CharSequence text,
                                Va_list args)

Dispatches a message. This routine is called either in the calling thread of the message or in the dispatcher thread.

Parameters:

dstBits - Destination identificator. If the bit mDispatchInDispatcherThread is set, the dispatching should be done only for a destination if the destination is valid for the dispatcher thread. Elsewhere if the bit is 0, the dispatching should be done only for a destination if the destination is valid for the calling thread.

bDispatchInDispatcherThread - true if this method is called in dispatcher thread, false if called in calling thread. This param is compared with MsgDispatcherCore.Output.dstInDispatcherThread, only if it is equal with them, the message is output.

bDispatchAlways - true then the output is used both in calling and in dispatcher thread. This boolean should be set only if the calling thread is the same as the dispatcher thread and the message should dispatch in the messag creation thread therefore.

identNumber - identification of the message.

creationTime -

text - The identifier text @pjava2c=zeroTermString.

args - @pjava2c=nonPersistent.

Returns:

0 if all destinations are processed, elsewhere dstBits with bits of non-processed dst.