com.bensherman.rtlsdrdjava.tcpcli

Class TcpClient

java.lang.Object

com.bensherman.rtlsdrdjava.tcpcli.TcpClient

All Implemented Interfaces:

java.lang.Runnable

public class TcpClient
extends java.lang.Object
implements java.lang.Runnable

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.concurrent.BlockingQueue<Message>	completedMsgQueue When a client writes a message to the server, once the response has been retrieved, this queue is updated with the Message instance describing the pair.
private java.lang.String	hostname
private boolean	keepAlive When this is set to false, if the thread containing this client instance is interrupted, the thread will die.
private int	portNum
static int	RTLSDRD_DEFAULT_TCP_PORT_NUMBER Default port number used by rtlsdrd
private java.util.concurrent.BlockingQueue<Message>	sendMsgQueue New messages to be sent to the server are placed in this queue.
private static java.lang.String	SOCKET_READER_THREAD_NAME Name to be given to the thread associated with the socketWriter instance.
private static java.lang.String	SOCKET_WRITER_THREAD_NAME Name to be given to the thread associated with the socketWriter instance.
private TcpSocketReader	socketReader The instance of TcpSocketReader associated with this client, which is used to handle socket reads.
private java.lang.Thread	socketReaderThread The thread which the socketReader instance is running in
private TcpSocketWriter	socketWriter The instance of TcpSocketWriter associated with this client, which is used to handle socket writes.
private java.lang.Thread	socketWriterThread The thread which the socketWriter instance is running in.
private static java.lang.String	TCP_CLIENT_DEFAULT_THREAD_NAME The name that the user should call this client
private java.net.Socket	tcpSocket Socket used to interact w/ the server
private static int	THREAD_JOIN_WAIT_TIME_MS When terminate() is called, the TcpSocketWriter and TcpSocketReader threads will have this parameter as their join() timeout.

Constructor Summary

Constructors

Constructor and Description
TcpClient(java.lang.String hostname, int portNum) Instantiates a new TcpClient

Method Summary

Modifier and Type	Method and Description
(package private) void	addToCompletedMsgQueue(Message completedMsg) Add a completed Message instance (i.e.
Message	getCompletedMessage() THIS CALL BLOCKS on completedMsgQueue.
int	getCompletedMessageQueueLength()
static java.lang.String	getDefaultThreadName()
(package private) TcpSocketReader	getTcpSocketReader() Returns this TcpClient's socketReader member.
private void	initMembers()
private void	logMsg(java.lang.String msg) Logs/outputs a message.
void	run() When this TcpClient is run as a thread, this function will be called.
void	sendToServer(java.lang.String msg) Writes a message to the server.
(package private) Message	takeMsgFromSendMsgQueue() Calls take() on the send message queue, causing the calling thread to block.
void	terminate() Stops the TcpClient thread as well as the TcpSocketWriter and TcpSocketReader threads.
private void	terminateSocketReaderThread() Requests that the socketReader thread die.
private void	terminateSocketWriterThread() Requests that the socketWriter thread die.

Methods inherited from class java.lang.Object

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

Field Detail

RTLSDRD_DEFAULT_TCP_PORT_NUMBER

public static final int RTLSDRD_DEFAULT_TCP_PORT_NUMBER

Default port number used by rtlsdrd

See Also:

Constant Field Values

TCP_CLIENT_DEFAULT_THREAD_NAME

private static final java.lang.String TCP_CLIENT_DEFAULT_THREAD_NAME

The name that the user should call this client

See Also:

Constant Field Values

THREAD_JOIN_WAIT_TIME_MS

private static final int THREAD_JOIN_WAIT_TIME_MS

When terminate() is called, the TcpSocketWriter and TcpSocketReader threads will have this parameter as their join() timeout.

See Also:

Constant Field Values

SOCKET_WRITER_THREAD_NAME

private static final java.lang.String SOCKET_WRITER_THREAD_NAME

Name to be given to the thread associated with the socketWriter instance.

See Also:

Constant Field Values

SOCKET_READER_THREAD_NAME

private static final java.lang.String SOCKET_READER_THREAD_NAME

Name to be given to the thread associated with the socketWriter instance.

See Also:

Constant Field Values

tcpSocket

private java.net.Socket tcpSocket

Socket used to interact w/ the server

socketWriter

private TcpSocketWriter socketWriter

The instance of TcpSocketWriter associated with this client, which is used to handle socket writes.

socketReader

private TcpSocketReader socketReader

The instance of TcpSocketReader associated with this client, which is used to handle socket reads.

socketWriterThread

private java.lang.Thread socketWriterThread

The thread which the socketWriter instance is running in.

socketReaderThread

private java.lang.Thread socketReaderThread

The thread which the socketReader instance is running in

completedMsgQueue

private final java.util.concurrent.BlockingQueue<Message> completedMsgQueue

When a client writes a message to the server, once the response has been retrieved, this queue is updated with the Message instance describing the pair. Note that this is a blocking queue which will endlessly grow if not tended to. TODO HAVE A LISTENER WHICH PULLS MESSAGES FROM THIS QUEUE

sendMsgQueue

private final java.util.concurrent.BlockingQueue<Message> sendMsgQueue

New messages to be sent to the server are placed in this queue. The TcpSocketWriter instance's thread will pend on this queue when empty, until a new message is placed into it. The messages in this queue should only have their outboundMsg field set.

keepAlive

private boolean keepAlive

When this is set to false, if the thread containing this client instance is interrupted, the thread will die.

hostname

private final java.lang.String hostname

portNum

private final int portNum

Constructor Detail

TcpClient

public TcpClient(java.lang.String hostname,
                 int portNum)
          throws java.io.IOException

Instantiates a new TcpClient

Parameters:

hostname - The hostname of the server (can be an IP or textual name to be resolved w/ DNS)

portNum - The port number to connect to on the server

Throws:

java.net.UnknownHostException - If the host's IP address couldn't be determined

java.io.IOException - If there was an error creating the socket, which can also occur during the instantiation of socketWriter and socketReader

Method Detail

initMembers

private void initMembers()
                  throws java.io.IOException

Throws:

java.io.IOException

run

public void run()

When this TcpClient is run as a thread, this function will be called. This function then starts the each of the socketWriter and socketReader threads.

Specified by:

run in interface java.lang.Runnable

logMsg

private void logMsg(java.lang.String msg)

Logs/outputs a message. Replace the System.out.println() with a logger if desired. The message format is ": msg"

Parameters:

msg - The msg to log

sendToServer

public void sendToServer(java.lang.String msg)

Writes a message to the server. This happens asynchronously.

Parameters:

msg - The message to send to the server

terminateSocketWriterThread

private void terminateSocketWriterThread()
                                  throws java.lang.InterruptedException

Requests that the socketWriter thread die. The join() call will wait THREAD_JOIN_WAIT_TIME_MS.

Throws:

java.lang.InterruptedException - If this thread is interrupted when calling join()

terminateSocketReaderThread

private void terminateSocketReaderThread()
                                  throws java.lang.InterruptedException

Requests that the socketReader thread die. The join() call will wait THREAD_JOIN_WAIT_TIME_MS.

Throws:

java.lang.InterruptedException - If this thread is interrupted when calling join()

terminate

public void terminate()
               throws java.io.IOException,
                      java.lang.InterruptedException

Stops the TcpClient thread as well as the TcpSocketWriter and TcpSocketReader threads. The socket is also closed. This TcpClient should NOT be used after executing this function. The socket is closed in order to wake the reader thread.

Throws:

java.io.IOException - If an IO error occurs when closing tcpSocket

java.lang.InterruptedException - If this thread is interrupted when terminating either of the reader or writer threads.

addToCompletedMsgQueue

void addToCompletedMsgQueue(Message completedMsg)

Add a completed Message instance (i.e. its response fields are set) to the completedMsgQueue.

Parameters:

completedMsg - A completed Message to add to completedMsgQueue

getCompletedMessage

public Message getCompletedMessage()
                            throws java.lang.InterruptedException

THIS CALL BLOCKS on completedMsgQueue. That is, if this function is called when completedMsgQueue is empty, the calling thread will wait until a Message becomes available.

Returns:

The head of the completedMsgQueue queue, which is the oldest completed Message which has not been pulled from the queue.

Throws:

java.lang.InterruptedException - If the calling thread is interrupted when waiting on completedMsgQueue.

getTcpSocketReader

TcpSocketReader getTcpSocketReader()

Returns this TcpClient's socketReader member. Intended to be used only by the socketWriter instance.

Returns:

This TcpClient's socketReader member.

getCompletedMessageQueueLength

public int getCompletedMessageQueueLength()

Returns:

The number of completed messages waiting to be received using getCompletedMessage()

getDefaultThreadName

public static java.lang.String getDefaultThreadName()

Returns:

The default name for the thread executing this class's run() method.

takeMsgFromSendMsgQueue

Message takeMsgFromSendMsgQueue()
                         throws java.lang.InterruptedException

Calls take() on the send message queue, causing the calling thread to block. Take() will remove the head of the queue.

Returns:

The oldest untaken message in the queue.

Throws:

java.lang.InterruptedException - If the take() operation was interrupted.