com.bensherman.rtlsdrdjava.tcpcli

Class TcpSocketWriter

java.lang.Object

com.bensherman.rtlsdrdjava.tcpcli.TcpSocketWriter

All Implemented Interfaces:

java.lang.Runnable

class TcpSocketWriter
extends java.lang.Object
implements java.lang.Runnable

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	keepAlive When set to false, if this thread is interrupted, it will die.
private TcpClient	tcpClient The TcpClient which instantiated this class.
private java.io.PrintWriter	tcpSocketWriter PrintWriter instance which is tied to the socket's output stream.

Constructor Summary

Constructors

Constructor and Description
TcpSocketWriter(java.net.Socket socketToWriteTo, TcpClient tcpClient) Constructs a new TcpSocketWriter.

Method Summary

Modifier and Type	Method and Description
private void	logMsg(java.lang.String msg) Logs/outputs a message.
(package private) void	requestStop() Sets the keepAlive flag to false.
void	run() The function called when this class is executed as a thread.
private void	write(Message msg) Writes the message specified by the parameter, followed by a newline to the server.

Methods inherited from class java.lang.Object

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

Field Detail

keepAlive

private boolean keepAlive

When set to false, if this thread is interrupted, it will die.

tcpSocketWriter

private final java.io.PrintWriter tcpSocketWriter

PrintWriter instance which is tied to the socket's output stream.

tcpClient

private final TcpClient tcpClient

The TcpClient which instantiated this class.

Constructor Detail

TcpSocketWriter

TcpSocketWriter(java.net.Socket socketToWriteTo,
                TcpClient tcpClient)
         throws java.io.IOException

Constructs a new TcpSocketWriter.

Parameters:

socketToWriteTo - The socket which is connected to the server, which this thread will write to.

tcpClient - The TcpClient which instantiated this class

Throws:

java.io.IOException - In the event that there was an error retrieving the output stream of the socket param

Method Detail

run

public void run()

The function called when this class is executed as a thread. this thread will pend on the sendMsgQueue, waiting for new messages to be submitted. When a new message has been submitted, this thread will retrieve it, remove it from the queue, and send it to the server. Then, the message will be added to the msgsWaitingForResponseQueue owned by the TcpSocketReader class/thread.

Specified by:

run in interface java.lang.Runnable

write

private void write(Message msg)

Writes the message specified by the parameter, followed by a newline to the server. The message is also added to the msgsWaitingForResponseQueue owned by the TcpSocketReader instance obtained from the TcpClient

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

requestStop

void requestStop()

Sets the keepAlive flag to false. If the thread executing run() is interrupted, thread will die.