jcifs.util.transport

Class Transport

java.lang.Object

jcifs.util.transport.Transport

All Implemented Interfaces:

AutoCloseable, Runnable

public abstract class Transport
extends Object
implements Runnable, AutoCloseable

This class simplifies communication for protocols that support multiplexing requests. It encapsulates a stream and some protocol knowledge (provided by a concrete subclass) so that connecting, disconnecting, sending, and receiving can be syncronized properly. Apparatus is provided to send and receive requests concurrently.

Constructor Summary

Constructors

Constructor and Description
Transport()

Method Summary

Modifier and Type	Method and Description
Transport	acquire()
void	close()
boolean	connect(long timeout) Connect the transport
boolean	disconnect(boolean hard) Disconnect the transport
boolean	disconnect(boolean hard, boolean inUse) Disconnect the transport
boolean	isDisconnected()
boolean	isFailed()
static int	readn(InputStream in, byte[] b, int off, int len) Read bytes from the input stream into a buffer
void	release()
void	run()
<T extends Response> T	sendrecv(Request request, T response, Set<RequestParam> params) Send a request message and recieve response
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Transport

public Transport()

Method Detail

readn

public static int readn(InputStream in,
                        byte[] b,
                        int off,
                        int len)
                 throws IOException

Read bytes from the input stream into a buffer

Parameters:

in -

b -

off -

len -

Returns:

number of bytes read

Throws:

IOException

acquire

public Transport acquire()

Returns:

session increased usage count

close

public void close()

Specified by:

close in interface AutoCloseable

See Also:

AutoCloseable.close()

release

public void release()

isDisconnected

public boolean isDisconnected()

Returns:

whether the transport is disconnected

isFailed

public boolean isFailed()

Returns:

whether the transport is marked failed

sendrecv

public <T extends Response> T sendrecv(Request request,
                                       T response,
                                       Set<RequestParam> params)
                                throws IOException

Send a request message and recieve response

Parameters:

request -

response -

params -

Returns:

the response

Throws:

IOException

connect

public boolean connect(long timeout)
                throws TransportException

Connect the transport

Parameters:

timeout -

Returns:

whether the transport was connected

Throws:

TransportException

disconnect

public boolean disconnect(boolean hard)
                   throws IOException

Disconnect the transport

Parameters:

hard -

Returns:

whether conenction was in use

Throws:

IOException

disconnect

public boolean disconnect(boolean hard,
                          boolean inUse)
                   throws IOException

Disconnect the transport

Parameters:

hard -

inUse - whether the caller is holding a usage reference on the transport

Returns:

whether conenction was in use

Throws:

IOException

run

public void run()

Specified by:

run in interface Runnable

toString

public String toString()

Overrides:

toString in class Object