org.alfresco.jlan.netbios.win32

Class NetBIOSSocket

java.lang.Object

org.alfresco.jlan.netbios.win32.NetBIOSSocket

public class NetBIOSSocket
extends java.lang.Object

NetBIOS Socket Class

Contains the details of a Winsock NetBIOS socket that was opened using native code.

Field Summary

Fields

Modifier and Type	Field and Description
static int	SocketWouldBlock

Method Summary

Methods

Modifier and Type	Method and Description
NetBIOSSocket	accept() Accept an incoming session connection and create a session socket for the new session.
int	available() Return the available data length for the socket
void	closeSocket() Close the socket
void	configureBlocking(boolean nonBlocking) Set this socket to use non-blocking I/O
static NetBIOSSocket	connectSocket(int lana, NetBIOSName remoteName) Create a NetBIOS socket that is connected to a remote server/service
static NetBIOSSocket	createListenerSocket(int lana, NetBIOSName nbName) Create a NetBIOS socket to listen for incoming sessions on the specified LANA
static NetBIOSSocket	createListenerSocket(int lana, NetBIOSName nbName, boolean fastAddName) Create a NetBIOS socket to listen for incoming sessions on the specified LANA
int	getLana() Return the NetBIOS LANA the socket is associated with
NetBIOSName	getName() Return the NetBIOS name.
int	getSocket() Return the socket pointer
int	hashCode() Return a hash code for the NetBIOS socket, using the socket id
boolean	hasSocket() Determine if the socket is valid
static void	initializeSockets() Initialize the Winsock NetBIOS interface
static boolean	isInitialized() Determine if the Winsock NetBIOS interface is initialized
boolean	isListener() Determine if this is a listener type socket
boolean	isNonBlocking() Check if this socket is in a non-blocking mode
int	read(byte[] buf, int off, int maxLen) Read data from the session socket
NetBIOSSelectionKey	register(NetBIOSSelector selector, int ops, java.lang.Object attachment) Register a non-blocking socket with a selector
static int	SelectReceiveSockets(int sockCnt, int[] sockList, int[] sockEvent) Wait for one or more asynchronous sockets to trigger a receive event
protected void	setSocket(int sockPtr) Set the socket pointer
static void	shutdownSockets() Shutdown the Winsock NetBIOS interface
java.lang.String	toString() Return the NetBIOS socket details as a string
int	write(byte[] buf, int off, int len) Write data to the session socket

Methods inherited from class java.lang.Object

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

Field Detail

SocketWouldBlock

public static final int SocketWouldBlock

See Also:

Constant Field Values

Method Detail

initializeSockets

public static final void initializeSockets()
                                    throws WinsockNetBIOSException

Initialize the Winsock NetBIOS interface

Throws:

WinsockNetBIOSException

shutdownSockets

public static final void shutdownSockets()

Shutdown the Winsock NetBIOS interface

isInitialized

public static final boolean isInitialized()

Determine if the Winsock NetBIOS interface is initialized

Returns:

boolean

SelectReceiveSockets

public static final int SelectReceiveSockets(int sockCnt,
                       int[] sockList,
                       int[] sockEvent)
                                      throws WinsockNetBIOSException

Wait for one or more asynchronous sockets to trigger a receive event

Parameters:

sockCnt - int

sockList - int[]

sockEvent - int[]

Returns:

int

Throws:

WinsockNetBIOSException

createListenerSocket

public static final NetBIOSSocket createListenerSocket(int lana,
                                 NetBIOSName nbName)
                                                throws WinsockNetBIOSException,
                                                       NetBIOSSocketException

Create a NetBIOS socket to listen for incoming sessions on the specified LANA

Parameters:

lana - int

nbName - NetBIOSName

Returns:

NetBIOSSocket

Throws:

NetBIOSSocketException

WinsockNetBIOSException

createListenerSocket

public static final NetBIOSSocket createListenerSocket(int lana,
                                 NetBIOSName nbName,
                                 boolean fastAddName)
                                                throws WinsockNetBIOSException,
                                                       NetBIOSSocketException

Create a NetBIOS socket to listen for incoming sessions on the specified LANA

Parameters:

lana - int

nbName - NetBIOSName

fastAddName - boolean

Returns:

NetBIOSSocket

Throws:

NetBIOSSocketException

WinsockNetBIOSException

connectSocket

public static final NetBIOSSocket connectSocket(int lana,
                          NetBIOSName remoteName)
                                         throws WinsockNetBIOSException,
                                                NetBIOSSocketException

Create a NetBIOS socket that is connected to a remote server/service

Parameters:

lana - int

remoteName - NetBIOSName

Returns:

NetBIOSSocket

Throws:

NetBIOSSocketException

WinsockNetBIOSException

getLana

public final int getLana()

Return the NetBIOS LANA the socket is associated with

Returns:

int

isListener

public final boolean isListener()

Determine if this is a listener type socket

Returns:

boolean

hasSocket

public final boolean hasSocket()

Determine if the socket is valid

Returns:

boolean

getSocket

public final int getSocket()

Return the socket pointer

Returns:

int

getName

public final NetBIOSName getName()

Return the NetBIOS name. For a listening socket this is the local name, for a session socket this is the remote callers name.

Returns:

NetBIOSName

configureBlocking

public final void configureBlocking(boolean nonBlocking)
                             throws WinsockNetBIOSException

Set this socket to use non-blocking I/O

Parameters:

nonBlocking - boolean

Throws:

WinsockNetBIOSException

write

public final int write(byte[] buf,
        int off,
        int len)
                throws WinsockNetBIOSException

Write data to the session socket

Parameters:

buf - byte[]

off - int

len - int

Returns:

int

Throws:

WinsockNetBIOSException

available

public final int available()
                    throws WinsockNetBIOSException

Return the available data length for the socket

Returns:

int

Throws:

WinsockNetBIOSException

read

public final int read(byte[] buf,
       int off,
       int maxLen)
               throws WinsockNetBIOSException

Read data from the session socket

Parameters:

buf - byte[]

off - int

maxLen - int

Returns:

int

Throws:

WinsockNetBIOSException

accept

public final NetBIOSSocket accept()
                           throws WinsockNetBIOSException,
                                  NetBIOSSocketException

Accept an incoming session connection and create a session socket for the new session. If the socket is in blocking mode then it will not return until a connection is received.

Returns:

NetBIOSSocket

Throws:

NetBIOSSocketException

winsockNetBIOSException

WinsockNetBIOSException

closeSocket

public final void closeSocket()

Close the socket

isNonBlocking

public final boolean isNonBlocking()

Check if this socket is in a non-blocking mode

Returns:

boolean

setSocket

protected final void setSocket(int sockPtr)

Set the socket pointer

Parameters:

sockPtr - int

register

public final NetBIOSSelectionKey register(NetBIOSSelector selector,
                           int ops,
                           java.lang.Object attachment)
                                   throws java.nio.channels.IllegalBlockingModeException,
                                          java.io.IOException

Register a non-blocking socket with a selector

Parameters:

selector - NetBIOSSelector

ops - int

attachment - Object

Returns:

NetBIOSSelectionKey

Throws:

java.nio.channels.IllegalBlockingModeException

java.io.IOException

toString

public java.lang.String toString()

Return the NetBIOS socket details as a string

Overrides:

toString in class java.lang.Object

Returns:

String

hashCode

public int hashCode()

Return a hash code for the NetBIOS socket, using the socket id

Overrides:

hashCode in class java.lang.Object

Returns:

int