org.vishia.communication

Class InterProcessCommRxThread

java.lang.Object

org.vishia.communication.InterProcessCommRxThread

public class InterProcessCommRxThread
extends java.lang.Object

This class provides a bundle with an InterProcessCommuniation and a receive thread. On received telegrams it invokes the InterProcessCommRx_ifc.execRxData(byte[], int, Address_InterProcessComm) which's instance should be given by construction.

• Use the static method create(String, InterProcessCommRx_ifc) or the constructor to create the instance with the given receive port and the given callback on received data.
• Invoke start() to open the communication and start the receive thread. It returns false on failures, true on success.
• Invoke shutdown() to close and finish the receive thread.
• Use createDstAddr(String) to create a destination address for the given InterProcessComm for sending activities.
• Use send(byte[], int, Address_InterProcessComm) to send.

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	bEnablePrintfOnComm
private int	ctErrorTelg
private byte[]	data_rxBuffer Use a static receive buffer.
private InterProcessCommRx_ifc	execRxData Reference to the execute routine on receiving data.
private InterProcessComm	ipc
private Address_InterProcessComm	myAnswerAddress
private int[]	nrofBytesReceived
private byte[]	rxBuffer For C: store the reference and length of the SimpleArray in the next structure.
private char	state State of function.
private java.lang.Thread	thread
private java.lang.Runnable	threadRoutine
static java.lang.String	version Version, history and license.

Constructor Summary

Constructors

Constructor and Description
InterProcessCommRxThread(java.lang.String ownAddrIpc, InterProcessCommRx_ifc execRxData) Creates the communication but does not open it yet.

Method Summary

Modifier and Type	Method and Description
static InterProcessCommRxThread	create(java.lang.String ownAddrIpc, InterProcessCommRx_ifc execRxData) Static method to create invokes the constructor.
Address_InterProcessComm	createDstAddr(java.lang.String sAddr) Create any destination address for the given InterprocessComm implementation.
private boolean	openComm(boolean blocking)
private void	receiveAndExecute()
private void	runThread()
int	send(byte[] data, int nrofBytesToSend, Address_InterProcessComm dstAddr) Send a telegram to the given dst.
void	shutdown() Shutdown the communication, close the thread.
boolean	start() Start opens the InterProcessComm and starts the receiver thread.

Methods inherited from class java.lang.Object

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

Field Detail

version

public static final java.lang.String version

Version, history and license.

• 2015-06-13 Hartmut: Created especially for C-usage of InterProcessCommunication. It is derived from org.vishia.inspectorTarget.Comm which uses this class as super class yet.

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 is 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

execRxData

private final InterProcessCommRx_ifc execRxData

Reference to the execute routine on receiving data.

state

private char state

State of function.

• o: opened
• e: error (open error)
• x: exit
• z: is exited.

bEnablePrintfOnComm

private boolean bEnablePrintfOnComm

ipc

private final InterProcessComm ipc

ctErrorTelg

private int ctErrorTelg

thread

private final java.lang.Thread thread

nrofBytesReceived

private final int[] nrofBytesReceived

data_rxBuffer

private final byte[] data_rxBuffer

Use a static receive buffer. It is important for C-applications.

rxBuffer

private final byte[] rxBuffer

For C: store the reference and length of the SimpleArray in the next structure.

myAnswerAddress

private final Address_InterProcessComm myAnswerAddress

threadRoutine

private final java.lang.Runnable threadRoutine

Constructor Detail

InterProcessCommRxThread

public InterProcessCommRxThread(java.lang.String ownAddrIpc,
                                InterProcessCommRx_ifc execRxData)

Creates the communication but does not open it yet. See start() The InterProcessComm interface implementation is got depending on

• the ownAddrIpc-string
• the existing InterProcessComm-Implementation, which analyzes the address-string.
  It means, the communication is not determined from this implementation, it depends on the parameter of the ownAddrIpc and the possibilities.

Parameters:

ownAddrIpc - The address String for receiving data. This String determines the kind of InterProcessComm. Use "UDP:127.9.0.1:6000" to open an UDP-Communication for this example via loop-back on port 6000. See InterProcessCommFactory, InterProcessCommFactorySocket.

execRxData - aggregation of executer of all commands.

Method Detail

create

public static InterProcessCommRxThread create(java.lang.String ownAddrIpc,
                                              InterProcessCommRx_ifc execRxData)

Static method to create invokes the constructor.

Parameters:

ownAddrIpc -

execRxData -

Returns:

createDstAddr

public final Address_InterProcessComm createDstAddr(java.lang.String sAddr)

Create any destination address for the given InterprocessComm implementation. The Address should be stored in the users space and should be used for send(byte[], int, Address_InterProcessComm)

Parameters:

sAddr - Proper String to create the address, see InterProcessComm.createAddress(String). Hint: For Socket communication it should not start with "UDP:", only the own address on constructor should start with the protocol. It should have the form "192.168.1.123:6000" with ip and port.

Returns:

the address, null on failure.

openComm

private final boolean openComm(boolean blocking)

start

public final boolean start()

Start opens the InterProcessComm and starts the receiver thread.

Returns:

true on success. On false the receiver thread was not started. Open error.

send

public final int send(byte[] data,
                      int nrofBytesToSend,
                      Address_InterProcessComm dstAddr)

Send a telegram to the given dst. It delegates to InterProcessComm.send(byte[], int, Address_InterProcessComm). An address should be create using createDstAddr(String).

Parameters:

data -

nrofBytesToSend -

dstAddr -

Returns:

runThread

private final void runThread()

receiveAndExecute

private final void receiveAndExecute()

shutdown

public final void shutdown()

Shutdown the communication, close the thread. This routine should be called either on shutdown of the whole system or on closing the inspector functionality. The inspector functionality can be restarted calling #start(Object).