public class GatewayServer extends DefaultGatewayServerListener implements java.lang.Runnable
This class enables Python programs to access a Java program. When a GatewayServer instance is started, Python programs can connect to the JVM by calling:
gateway = JavaGateway()
The
entryPoint
passed to a GatewayServer can be accessed with the entry_point
member:
gateway.entry_point
Technically, a GatewayServer is only responsible for accepting connection.
Each connection is then handled by a GatewayConnection
instance and the various states (e.g., entryPoint,
reference to returned objects) are managed by a Gateway
instance.
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
DEFAULT_ADDRESS |
static int |
DEFAULT_CONNECT_TIMEOUT |
static int |
DEFAULT_PORT |
static int |
DEFAULT_PYTHON_PORT |
static int |
DEFAULT_READ_TIMEOUT |
static java.lang.String |
GATEWAY_SERVER_ID |
Constructor and Description |
---|
GatewayServer(java.lang.Object entryPoint)
Creates a GatewayServer instance with default port (25333), default
address (127.0.0.1), and default timeout value (no timeout).
|
GatewayServer(java.lang.Object entryPoint,
int port) |
GatewayServer(java.lang.Object entryPoint,
int port,
int pythonPort,
java.net.InetAddress address,
java.net.InetAddress pythonAddress,
int connectTimeout,
int readTimeout,
java.util.List<java.lang.Class<? extends Command>> customCommands) |
GatewayServer(java.lang.Object entryPoint,
int port,
int connectTimeout,
int readTimeout) |
GatewayServer(java.lang.Object entryPoint,
int port,
int pythonPort,
int connectTimeout,
int readTimeout,
java.util.List<java.lang.Class<? extends Command>> customCommands) |
GatewayServer(java.lang.Object entryPoint,
int port,
int connectTimeout,
int readTimeout,
java.util.List<java.lang.Class<? extends Command>> customCommands,
CallbackClient cbClient) |
Modifier and Type | Method and Description |
---|---|
void |
addListener(GatewayServerListener listener) |
void |
connectionStopped(GatewayConnection gatewayConnection) |
protected GatewayConnection |
createConnection(Gateway gateway,
java.net.Socket socket) |
protected void |
fireConnectionError(java.lang.Exception e) |
protected void |
fireConnectionStarted(GatewayConnection gatewayConnection) |
protected void |
fireServerError(java.lang.Exception e) |
protected void |
fireServerPostShutdown() |
protected void |
fireServerPreShutdown() |
protected void |
fireServerStarted() |
protected void |
fireServerStopped() |
java.net.InetAddress |
getAddress() |
CallbackClient |
getCallbackClient() |
int |
getConnectTimeout() |
java.util.List<java.lang.Class<? extends Command>> |
getCustomCommands() |
java.util.List<GatewayServerListener> |
getListeners() |
int |
getListeningPort() |
int |
getPort() |
java.net.InetAddress |
getPythonAddress() |
int |
getPythonPort() |
int |
getReadTimeout() |
static void |
main(java.lang.String[] args)
Main method to start a local GatewayServer on a given port.
|
void |
removeListener(GatewayServerListener listener) |
void |
resetCallbackClient(java.net.InetAddress pythonAddress,
int pythonPort)
Replace the callback client with the new one which connects to the given address
and port.
|
void |
run() |
void |
shutdown()
Stops accepting connections, closes all current connections, and calls
Gateway.shutdown() |
void |
shutdown(boolean shutdownCallbackClient)
Stops accepting connections, closes all current connections, and calls
Gateway.shutdown() |
void |
start()
Starts to accept connections in a second thread (non-blocking call).
|
void |
start(boolean fork)
Starts to accept connections.
|
protected void |
startSocket()
Starts the ServerSocket.
|
static void |
turnAllLoggingOn()
Utility method to turn logging on.
|
static void |
turnLoggingOff()
Utility method to turn logging off.
|
static void |
turnLoggingOn()
Utility method to turn logging on.
|
connectionError, connectionStarted, serverError, serverPostShutdown, serverPreShutdown, serverStarted, serverStopped
public static final java.lang.String DEFAULT_ADDRESS
public static final int DEFAULT_PORT
public static final int DEFAULT_PYTHON_PORT
public static final int DEFAULT_CONNECT_TIMEOUT
public static final int DEFAULT_READ_TIMEOUT
public static final java.lang.String GATEWAY_SERVER_ID
public GatewayServer(java.lang.Object entryPoint)
Creates a GatewayServer instance with default port (25333), default address (127.0.0.1), and default timeout value (no timeout).
entryPoint
- The entry point of this Gateway. Can be null.public GatewayServer(java.lang.Object entryPoint, int port)
entryPoint
- The entry point of this Gateway. Can be null.port
- The port the GatewayServer is listening to.public GatewayServer(java.lang.Object entryPoint, int port, int pythonPort, java.net.InetAddress address, java.net.InetAddress pythonAddress, int connectTimeout, int readTimeout, java.util.List<java.lang.Class<? extends Command>> customCommands)
entryPoint
- The entry point of this Gateway. Can be null.port
- The port the GatewayServer is listening to.pythonPort
- The port used by a PythonProxyHandler to connect to a Python
gateway. Essentially the port used for Python callbacks.address
- The address the GatewayServer is listening to.pythonAddress
- The address used by a PythonProxyHandler to connect to a
Python gateway.connectTimeout
- Time in milliseconds (0 = infinite). If a GatewayServer does
not receive a connection request after this time, it closes
the server socket and no other connection is accepted.readTimeout
- Time in milliseconds (0 = infinite). Once a Python program is
connected, if a GatewayServer does not receive a request
(e.g., a method call) after this time, the connection with the
Python program is closed.customCommands
- A list of custom Command classes to augment the Server
features. These commands will be accessible from Python
programs. Can be null.public GatewayServer(java.lang.Object entryPoint, int port, int connectTimeout, int readTimeout)
entryPoint
- The entry point of this Gateway. Can be null.port
- The port the GatewayServer is listening to.connectTimeout
- Time in milliseconds (0 = infinite). If a GatewayServer does
not receive a connection request after this time, it closes
the server socket and no other connection is accepted.readTimeout
- Time in milliseconds (0 = infinite). Once a Python program is
connected, if a GatewayServer does not receive a request
(e.g., a method call) after this time, the connection with the
Python program is closed.public GatewayServer(java.lang.Object entryPoint, int port, int pythonPort, int connectTimeout, int readTimeout, java.util.List<java.lang.Class<? extends Command>> customCommands)
entryPoint
- The entry point of this Gateway. Can be null.port
- The port the GatewayServer is listening to.pythonPort
- The port used by a PythonProxyHandler to connect to a Python
gateway. Essentially the port used for Python callbacks.connectTimeout
- Time in milliseconds (0 = infinite). If a GatewayServer does
not receive a connection request after this time, it closes
the server socket and no other connection is accepted.readTimeout
- Time in milliseconds (0 = infinite). Once a Python program is
connected, if a GatewayServer does not receive a request
(e.g., a method call) after this time, the connection with the
Python program is closed.customCommands
- A list of custom Command classes to augment the Server
features. These commands will be accessible from Python
programs. Can be null.public GatewayServer(java.lang.Object entryPoint, int port, int connectTimeout, int readTimeout, java.util.List<java.lang.Class<? extends Command>> customCommands, CallbackClient cbClient)
public static void turnAllLoggingOn()
Utility method to turn logging on. Logging is turned off by default. All log messages will be logged.
public static void turnLoggingOff()
Utility method to turn logging off. Logging is turned off by default.
public static void turnLoggingOn()
Utility method to turn logging on. Logging is turned off by default. Log messages up to INFO level will be logged.
public void resetCallbackClient(java.net.InetAddress pythonAddress, int pythonPort)
Replace the callback client with the new one which connects to the given address and port. This method is useful if for some reason your CallbackServer changes its address or you come to know of the address after Gateway has already instantiated.
This method is not thread-safe! Make sure that only one thread calls this method.
pythonAddress
- The address used by a PythonProxyHandler to connect to a
Python gateway.pythonPort
- The port used by a PythonProxyHandler to connect to a Python
gateway. Essentially the port used for Python callbacks.public void addListener(GatewayServerListener listener)
public void connectionStopped(GatewayConnection gatewayConnection)
connectionStopped
in interface GatewayServerListener
connectionStopped
in class DefaultGatewayServerListener
protected GatewayConnection createConnection(Gateway gateway, java.net.Socket socket) throws java.io.IOException
java.io.IOException
protected void fireConnectionError(java.lang.Exception e)
protected void fireConnectionStarted(GatewayConnection gatewayConnection)
protected void fireServerError(java.lang.Exception e)
protected void fireServerPostShutdown()
protected void fireServerPreShutdown()
protected void fireServerStarted()
protected void fireServerStopped()
public java.net.InetAddress getAddress()
public CallbackClient getCallbackClient()
public int getConnectTimeout()
public int getListeningPort()
public int getPort()
public java.net.InetAddress getPythonAddress()
public int getPythonPort()
public int getReadTimeout()
public void removeListener(GatewayServerListener listener)
public void run()
run
in interface java.lang.Runnable
public void shutdown()
Stops accepting connections, closes all current connections, and calls
Gateway.shutdown()
public void shutdown(boolean shutdownCallbackClient)
Stops accepting connections, closes all current connections, and calls
Gateway.shutdown()
shutdownCallbackClient
- If True, shuts down the CallbackClient
instance.public void start()
Starts to accept connections in a second thread (non-blocking call).
public void start(boolean fork)
Starts to accept connections.
fork
- If true, the GatewayServer accepts connection in another
thread and this call is non-blocking. If False, the
GatewayServer accepts connection in this thread and the call
is blocking (until the Gateway is shutdown by another thread).Py4JNetworkException
- If the server socket cannot start.protected void startSocket() throws Py4JNetworkException
Starts the ServerSocket.
Py4JNetworkException
- If the port is busy.public static void main(java.lang.String[] args)
Main method to start a local GatewayServer on a given port. The listening port is printed to stdout so that clients can start servers on ephemeral ports.
public java.util.List<java.lang.Class<? extends Command>> getCustomCommands()
public java.util.List<GatewayServerListener> getListeners()