org.eclipse.paho.client.mqttv3.internal

Class TCPNetworkModule

java.lang.Object

org.eclipse.paho.client.mqttv3.internal.TCPNetworkModule

All Implemented Interfaces:

NetworkModule

Direct Known Subclasses:

SSLNetworkModule, WebSocketNetworkModule

public class TCPNetworkModule
extends java.lang.Object
implements NetworkModule

A network module for connecting over TCP.

Constructor Summary

Constructors

Constructor and Description
TCPNetworkModule(javax.net.SocketFactory factory, java.lang.String host, int port, java.lang.String resourceContext) Constructs a new TCPNetworkModule using the specified host and port.

Method Summary

Modifier and Type	Method and Description
java.io.InputStream	getInputStream()
java.io.OutputStream	getOutputStream()
java.lang.String	getServerURI()
void	setConnectTimeout(int timeout) Set the maximum time to wait for a socket to be established
void	start() Starts the module, by creating a TCP socket to the server.
void	stop() Stops the module, by closing the TCP socket.

Methods inherited from class java.lang.Object

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

Constructor Detail

TCPNetworkModule

public TCPNetworkModule(javax.net.SocketFactory factory,
                        java.lang.String host,
                        int port,
                        java.lang.String resourceContext)

Constructs a new TCPNetworkModule using the specified host and port. The supplied SocketFactory is used to supply the network socket.

Method Detail

start

public void start()
           throws java.io.IOException,
                  MqttException

Starts the module, by creating a TCP socket to the server.

Specified by:

start in interface NetworkModule

Throws:

java.io.IOException

MqttException

getInputStream

public java.io.InputStream getInputStream()
                                   throws java.io.IOException

Specified by:

getInputStream in interface NetworkModule

Throws:

java.io.IOException

getOutputStream

public java.io.OutputStream getOutputStream()
                                     throws java.io.IOException

Specified by:

getOutputStream in interface NetworkModule

Throws:

java.io.IOException

stop

public void stop()
          throws java.io.IOException

Stops the module, by closing the TCP socket.

Specified by:

stop in interface NetworkModule

Throws:

java.io.IOException

setConnectTimeout

public void setConnectTimeout(int timeout)

Set the maximum time to wait for a socket to be established

Parameters:

timeout -

getServerURI

public java.lang.String getServerURI()

Specified by:

getServerURI in interface NetworkModule