org.alfresco.jlan.netbios

Class NetworkSession

java.lang.Object

org.alfresco.jlan.netbios.NetworkSession

Direct Known Subclasses:

NetBIOSSession, TcpipSMBNetworkSession, TcpipSMBNetworkSession

public abstract class NetworkSession
extends java.lang.Object

Network Session Abstract Class

Base class for client network sessions.

Constructor Summary

Constructors

Constructor and Description
NetworkSession(java.lang.String protoName) Class constructor

Method Summary

Methods

Modifier and Type	Method and Description
abstract void	Close() Close the network session
static int	getDefaultTimeout() Return the default socket timeout value
java.lang.String	getProtocolName() Return the protocol name
int	getTimeout() Return the send/receive timeout, in milliseconds
abstract boolean	hasData() Check if the network session has data available
abstract boolean	isConnected() Determine if the session is connected to a remote host
abstract void	Open(java.lang.String toName, java.lang.String fromName, java.lang.String toAddr) Open a connection to a remote host
abstract int	Receive(byte[] buf) Receive a data packet from the remote host.
abstract boolean	Send(byte[] data, int siz) Send a data packet to the remote host.
static void	setDefaultTimeout(int tmo) Set the default socket timeout for new sessions
void	setTimeout(int tmo) Set the send/receive timeout, in milliseconds

Methods inherited from class java.lang.Object

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

Constructor Detail

NetworkSession

public NetworkSession(java.lang.String protoName)

Class constructor

Parameters:

protoName - String

Method Detail

getProtocolName

public final java.lang.String getProtocolName()

Return the protocol name

Returns:

String

Open

public abstract void Open(java.lang.String toName,
        java.lang.String fromName,
        java.lang.String toAddr)
                   throws java.io.IOException,
                          java.net.UnknownHostException

Open a connection to a remote host

Parameters:

toName - Host name/address being called

fromName - Local host name/address

toAddr - Optional address of the remote host

Throws:

java.io.IOException

java.net.UnknownHostException

isConnected

public abstract boolean isConnected()

Determine if the session is connected to a remote host

Returns:

boolean

hasData

public abstract boolean hasData()
                         throws java.io.IOException

Check if the network session has data available

Returns:

boolean

Throws:

java.io.IOException

getTimeout

public final int getTimeout()

Return the send/receive timeout, in milliseconds

Returns:

int

Receive

public abstract int Receive(byte[] buf)
                     throws java.io.IOException

Receive a data packet from the remote host.

Parameters:

buf - Byte buffer to receive the data into.

Returns:

Length of the received data.

Throws:

java.io.IOException - I/O error occurred.

Send

public abstract boolean Send(byte[] data,
           int siz)
                      throws java.io.IOException

Send a data packet to the remote host.

Parameters:

data - Byte array containing the data to be sent.

siz - Length of the data to send.

Returns:

true if the data was sent successfully, else false.

Throws:

java.io.IOException - I/O error occurred.

Close

public abstract void Close()
                    throws java.io.IOException

Close the network session

Throws:

java.io.IOException - I/O error occurred

setTimeout

public void setTimeout(int tmo)

Set the send/receive timeout, in milliseconds

Parameters:

tmo - int

getDefaultTimeout

public static final int getDefaultTimeout()

Return the default socket timeout value

Returns:

int

setDefaultTimeout

public static final void setDefaultTimeout(int tmo)

Set the default socket timeout for new sessions

Parameters:

tmo - int