py4j

Class CallbackConnection

java.lang.Object

py4j.CallbackConnection

All Implemented Interfaces:

Py4JClientConnection

public class CallbackConnection
extends Object
implements Py4JClientConnection

Default implementation of the CommunicationChannel interface using TCP sockets.

Author:

Barthelemy Dagenais

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_NONBLOCKING_SO_TIMEOUT

Constructor Summary

Constructors

Constructor and Description
CallbackConnection(int port, InetAddress address)
CallbackConnection(int port, InetAddress address, SocketFactory socketFactory)
CallbackConnection(int port, InetAddress address, SocketFactory socketFactory, int readTimeout)
CallbackConnection(int port, InetAddress address, SocketFactory socketFactory, int readTimeout, String authToken)

Method Summary

Modifier and Type	Method and Description
protected String	readBlockingResponse(BufferedReader reader)
protected String	readNonBlockingResponse(Socket socket, BufferedReader reader)
String	sendCommand(String command)
String	sendCommand(String command, boolean blocking)
void	setUsed(boolean used)
void	shutdown()
void	shutdown(boolean reset) Shuts down the connection by closing the socket, the writer, and the reader.
void	start()
boolean	wasUsed()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_NONBLOCKING_SO_TIMEOUT

public static final int DEFAULT_NONBLOCKING_SO_TIMEOUT

See Also:

Constant Field Values

Constructor Detail

CallbackConnection

public CallbackConnection(int port,
                          InetAddress address)

CallbackConnection

public CallbackConnection(int port,
                          InetAddress address,
                          SocketFactory socketFactory)

CallbackConnection

public CallbackConnection(int port,
                          InetAddress address,
                          SocketFactory socketFactory,
                          int readTimeout)

Parameters:

port - The port used to connect to the Python side.

address - The address used to connect to the Java side.

socketFactory - The socket factory used to create a socket (connection) to the Python side.

readTimeout - Time in milliseconds (0 = infinite). Once connected to the Python side, if the Java side does not receive a response after this time, the connection with the Python program is closed. If readTimeout = 0, a default readTimeout of 1000 is used for operations that must absolutely be non-blocking.

CallbackConnection

public CallbackConnection(int port,
                          InetAddress address,
                          SocketFactory socketFactory,
                          int readTimeout,
                          String authToken)

Parameters:

port - The port used to connect to the Python side.

address - The address used to connect to the Java side.

socketFactory - The socket factory used to create a socket (connection) to the Python side.

readTimeout - Time in milliseconds (0 = infinite). Once connected to the Python side, if the Java side does not receive a response after this time, the connection with the Python program is closed. If readTimeout = 0, a default readTimeout of 1000 is used for operations that must absolutely be non-blocking.

authToken - Token for authenticating with the callback server.

Method Detail

sendCommand

public String sendCommand(String command)

Specified by:

sendCommand in interface Py4JClientConnection

sendCommand

public String sendCommand(String command,
                          boolean blocking)

Specified by:

sendCommand in interface Py4JClientConnection

readBlockingResponse

protected String readBlockingResponse(BufferedReader reader)
                               throws IOException

Throws:

IOException

readNonBlockingResponse

protected String readNonBlockingResponse(Socket socket,
                                         BufferedReader reader)
                                  throws IOException

Throws:

IOException

setUsed

public void setUsed(boolean used)

Specified by:

setUsed in interface Py4JClientConnection

shutdown

public void shutdown()

Specified by:

shutdown in interface Py4JClientConnection

shutdown

public void shutdown(boolean reset)

Shuts down the connection by closing the socket, the writer, and the reader.

Internal: at this point, the connection has not been given back to the connections deque, or the deque is about to be cleared.

Specified by:

shutdown in interface Py4JClientConnection

start

public void start()
           throws IOException

Specified by:

start in interface Py4JClientConnection

Throws:

IOException

wasUsed

public boolean wasUsed()

Specified by:

wasUsed in interface Py4JClientConnection