|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectpy4j.CallbackClient
public class CallbackClient
A CallbackClient is responsible for managing communication channels: channels are created as needed (e.g., one per concurrent thread) and are closed after a certain time.
Field Summary | |
---|---|
static long |
DEFAULT_MIN_CONNECTION_TIME
|
Constructor Summary | |
---|---|
CallbackClient(int port)
|
|
CallbackClient(int port,
InetAddress address)
|
|
CallbackClient(int port,
InetAddress address,
long minConnectionTime,
TimeUnit minConnectionTimeUnit)
|
Method Summary | |
---|---|
int |
getPort()
|
void |
periodicCleanup()
Closes communication channels that have not been used for a time specified at the creation of the callback client. |
String |
sendCommand(String command)
Sends a command to the Python side. |
void |
shutdown()
Closes all active channels, stops the periodic cleanup of channels and mark the client as shutting down. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final long DEFAULT_MIN_CONNECTION_TIME
Constructor Detail |
---|
public CallbackClient(int port)
public CallbackClient(int port, InetAddress address)
public CallbackClient(int port, InetAddress address, long minConnectionTime, TimeUnit minConnectionTimeUnit)
port
- The port used by channels to connect to the Python side.address
- The addressed used by channels to connect to the Python side..minConnectionTime
- The minimum connection time: channels are guaranteed to stay
connected for this time after sending a command.minConnectionTimeUnit
- The minimum coonnection time unit.Method Detail |
---|
public String sendCommand(String command)
Sends a command to the Python side. This method is typically used by Python proxies to call Python methods or to request the garbage collection of a proxy.
command
- The command to send.
public void shutdown()
Closes all active channels, stops the periodic cleanup of channels and mark the client as shutting down. No more commands can be send after this method has been called, except commands that were initiated before the shutdown method was called..
public void periodicCleanup()
Closes communication channels that have not been used for a time specified at the creation of the callback client.
Clients should not directly call this method: it is called by a periodic cleaner thread.
public int getPort()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |