|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectnet.i2p.sam.SAMHandler
abstract class SAMHandler
Base class for SAM protocol handlers. It implements common methods, but is not able to actually parse the protocol itself: this task is delegated to subclasses.
Field Summary | |
---|---|
protected Log |
_log
|
protected SAMBridge |
bridge
|
protected Properties |
i2cpProps
I2CP options configuring the I2CP connection (port, host, numHops, etc) |
protected SocketChannel |
socket
|
protected boolean |
stopHandler
|
protected Object |
stopLock
|
protected I2PAppThread |
thread
|
protected int |
verMajor
|
protected int |
verMinor
|
Constructor Summary | |
---|---|
protected |
SAMHandler(SocketChannel s,
int verMajor,
int verMinor,
Properties i2cpProps,
SAMBridge parent)
SAMHandler constructor (to be called by subclasses) |
Method Summary | |
---|---|
protected void |
closeClientSocket()
Close the socket connected to the SAM client. |
protected SocketChannel |
getClientSocket()
Get the channel of the socket connected to the SAM client |
protected Object |
getWriteLock()
If you're crazy enough to write to the raw socket, grab the write lock with getWriteLock(), synchronize against it, and write to the getOut() |
protected abstract void |
handle()
Actually handle the SAM protocol. |
void |
run()
Register with the bridge, call handle(), unregister with the bridge. |
protected boolean |
shouldStop()
Should the handler be stopped? |
void |
startHandling()
Start handling the SAM connection, detaching an handling thread. |
void |
stopHandling()
Stop the SAM handler, close the client socket, unregister with the bridge. |
String |
toString()
Get a string describing the handler. |
protected void |
writeBytes(ByteBuffer data)
Write a byte array on the handler's socket. |
static void |
writeBytes(ByteBuffer data,
SocketChannel out)
|
protected boolean |
writeString(String str)
Write a string to the handler's socket. |
static boolean |
writeString(String str,
SocketChannel out)
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
protected final Log _log
protected I2PAppThread thread
protected final SAMBridge bridge
protected final SocketChannel socket
protected final int verMajor
protected final int verMinor
protected final Properties i2cpProps
protected final Object stopLock
protected boolean stopHandler
Constructor Detail |
---|
protected SAMHandler(SocketChannel s, int verMajor, int verMinor, Properties i2cpProps, SAMBridge parent) throws IOException
s
- Socket attached to a SAM clientverMajor
- SAM major version to manageverMinor
- SAM minor version to managei2cpProps
- properties to configure the I2CP connection (host, port, etc)
IOException
Method Detail |
---|
public final void startHandling()
protected abstract void handle()
protected final SocketChannel getClientSocket()
protected final void writeBytes(ByteBuffer data) throws IOException
data
- A byte array to be written
IOException
public static void writeBytes(ByteBuffer data, SocketChannel out) throws IOException
IOException
protected Object getWriteLock()
protected final boolean writeString(String str)
str
- A byte array to be written
public static boolean writeString(String str, SocketChannel out)
protected final void closeClientSocket() throws IOException
IOException
public void stopHandling()
stopHandling
in interface Handler
protected final boolean shouldStop()
public final String toString()
toString
in class Object
public final void run()
run
in interface Runnable
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |