org.alfresco.jlan.netbios.win32

Class Win32NetBIOS

java.lang.Object

org.alfresco.jlan.netbios.win32.Win32NetBIOS

public class Win32NetBIOS
extends Object

Win32 NetBIOS Native Call Wrapper Class

Author:

gkspencer

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	FindNameBufferLen

Constructor Summary

Constructors

Constructor and Description
Win32NetBIOS()

Method Summary

Modifier and Type	Method and Description
static int	AddGroupName(int lana, byte[] name) Add a group NetBIOS name to the local name table
static int	AddName(int lana, byte[] name) Add a NetBIOS name to the local name table
protected static int	BindSocket(int sockPtr, byte[] name) Bind a NetBIOS socket to a name to listen for incoming sessions
protected static int	BindSocket(int sockPtr, byte[] name, boolean fastAddName) Bind a NetBIOS socket to a name to listen for incoming sessions
protected static void	CloseSocket(int sockPtr) Close a NetBIOS socket
protected static void	ConnectSocket(int sockPtr, byte[] remoteName) Connect to a remote server
protected static int	CreateSocket(int lana) Create a NetBIOS socket
static int	DeleteName(int lana, byte[] name) Delete a NetBIOS name from the local name table
static int	FindName(int lana, NetBIOSName nbName) Find a NetBIOS name
static int	FindNameRaw(int lana, byte[] name, byte[] nameBuf, int bufLen) Find a NetBIOS name, return the name buffer
static String	getAdapterNameForLANA(int lana) Find the adapter name for a LANA
static String	getIPAddressForLANA(int lana) Find the TCP/IP address for a LANA
static int	getLANAForAdapterName(String name) Find the LANA for a network adapter
static int	getLANAForIPAddress(String addr) Find the LANA for a TCP/IP address
static String	GetLocalDomainName() Return the local domain name
static String	GetLocalNetBIOSName() Return the local computers NetBIOS name
protected static int	GetMaximumSocketsPerSelect() Return the maximum number of sockets that can be configured per SelectSockets() call
static int	getSocketReceiveBufferSize(int sockPtr) Get the current receive buffer size for the socket
static int	getSocketSendBufferSize(int sockPtr) Get the current send buffer size for the socket
static String	getWINSServerList() Return a comma delimeted list of WINS server TCP/IP addresses, or null if no WINS servers are configured.
static int	Hangup(int lana, int lsn) Hangup a session
protected static void	InitializeSockets() Initialize the NetBIOS socket interface
static int[]	LanaEnumerate() Enumerate the available LANAs
static int	Listen(int lana, byte[] toName, byte[] fromName, byte[] callerName) Listen for an incoming session request
protected static int	ListenSocket(int sockPtr, byte[] callerName) Listen for an incoming connection
static int	Receive(int lana, int lsn, byte[] buf, int off, int maxLen) Receive a data packet on a session
static int	ReceiveBroadcastDatagram(int lana, int nameNum, byte[] buf, int off, int maxLen) Receive a broadcast datagram
static int	ReceiveDatagram(int lana, int nameNum, byte[] buf, int off, int maxLen) Receive a datagram on a specified name
protected static int	ReceiveLengthSocket(int sockPtr) Return the amount of receive data available on the socket
protected static int	ReceiveSocket(int sockPtr, byte[] buf, int off, int maxLen) Receive data on a session socket
static int	Reset(int lana) Reset the NetBIOS environment
protected static int	SelectReceiveSockets(int sockCnt, int[] readSocksIn, int[] readSocksOut) Wait for an event on one or more sockets
static int	Send(int lana, int lsn, byte[] buf, int off, int len) Send a data packet on a session
static int	SendBroadcastDatagram(int lana, byte[] buf, int off, int len) Send a broadcast datagram
static int	SendDatagram(int lana, int srcNum, byte[] destName, byte[] buf, int off, int len) Send a datagram to a specified name
protected static int	SendSocket(int sockPtr, byte[] buf, int off, int len) Send data on a session socket
protected static int	SetNonBlockingSocket(int sockPtr, boolean nonBlocking) Configure a socket to be non-blocking
static void	setSocketReceiveBufferSize(int sockPtr, int bufSize) Set the socket receive buffer size
static void	setSocketSendBufferSize(int sockPtr, int bufSize) Set the socket send buffer size
protected static void	ShutdownSockets() Shutdown the NetBIOS socket interface
static void	waitForNetworkAddressChange() Wait for a network address change event, block until a change occurs or the Winsock NetBIOS interface is shut down
static void	Win32CloseEvent(int eventHandle) Close a Win32 event
static int	Win32CreateEvent() Create a Win32 event
static boolean	Win32ResetEvent(int eventHandle) Reset a Win32 event
static boolean	Win32SetEvent(int eventHandle) Set a Win32 event
static void	WinsockCloseEvent(int eventHandle) Close a Winsock event
static int	WinsockCreateEvent() Create a Winsock event
static int	WinsockEnumNetworkEvents(int sockPtr, int eventHandle) Get the list of socket events that have triggered for a particular socket
static void	WinsockEventSelect(int sockPtr, int eventHandle, int eventMask) Set Winsock events for a socket
static boolean	WinsockResetEvent(int eventHandle) Reset a Winsock event
static boolean	WinsockSetEvent(int eventHandle) Set a Winsock event
static int	WinsockWaitForMultipleEvents(int eventCnt, int[] events, boolean waitAll, int timeout, boolean alertable) Wait for Winsock events

Methods inherited from class java.lang.Object

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

Field Detail

FindNameBufferLen

protected static final int FindNameBufferLen

See Also:

Constant Field Values

Constructor Detail

Win32NetBIOS

public Win32NetBIOS()

Method Detail

AddName

public static int AddName(int lana,
                          byte[] name)

Add a NetBIOS name to the local name table

Parameters:

lana - int

name - byte[]

Returns:

int

AddGroupName

public static int AddGroupName(int lana,
                               byte[] name)

Add a group NetBIOS name to the local name table

Parameters:

lana - int

name - byte[]

Returns:

int

FindNameRaw

public static int FindNameRaw(int lana,
                              byte[] name,
                              byte[] nameBuf,
                              int bufLen)

Find a NetBIOS name, return the name buffer

Parameters:

lana - int

name - byte[]

nameBuf - byte[]

bufLen - int

Returns:

int

FindName

public static int FindName(int lana,
                           NetBIOSName nbName)

Find a NetBIOS name

Parameters:

lana - int

nbName - NetBIOSName

Returns:

int

DeleteName

public static int DeleteName(int lana,
                             byte[] name)

Delete a NetBIOS name from the local name table

Parameters:

lana - int

name - byte[]

Returns:

int

LanaEnumerate

public static int[] LanaEnumerate()

Enumerate the available LANAs

Returns:

int[]

Reset

public static int Reset(int lana)

Reset the NetBIOS environment

Parameters:

lana - int

Returns:

int

Listen

public static int Listen(int lana,
                         byte[] toName,
                         byte[] fromName,
                         byte[] callerName)

Listen for an incoming session request

Parameters:

lana - int

toName - byte[]

fromName - byte[]

callerName - byte[]

Returns:

int

Receive

public static int Receive(int lana,
                          int lsn,
                          byte[] buf,
                          int off,
                          int maxLen)

Receive a data packet on a session

Parameters:

lana - int

lsn - int

buf - byte[]

off - int

maxLen - int

Returns:

int

Send

public static int Send(int lana,
                       int lsn,
                       byte[] buf,
                       int off,
                       int len)

Send a data packet on a session

Parameters:

lana - int

lsn - int

buf - byte[]

off - int

len - int

Returns:

int

SendDatagram

public static int SendDatagram(int lana,
                               int srcNum,
                               byte[] destName,
                               byte[] buf,
                               int off,
                               int len)

Send a datagram to a specified name

Parameters:

lana - int

srcNum - int

destName - byte[]

buf - byte[]

off - int

len - int

Returns:

int

SendBroadcastDatagram

public static int SendBroadcastDatagram(int lana,
                                        byte[] buf,
                                        int off,
                                        int len)

Send a broadcast datagram

Parameters:

lana - int

buf - byte[]

off - int

len - int

Returns:

int

ReceiveDatagram

public static int ReceiveDatagram(int lana,
                                  int nameNum,
                                  byte[] buf,
                                  int off,
                                  int maxLen)

Receive a datagram on a specified name

Parameters:

lana - int

nameNum - int

buf - byte[]

off - int

maxLen - int

Returns:

int

ReceiveBroadcastDatagram

public static int ReceiveBroadcastDatagram(int lana,
                                           int nameNum,
                                           byte[] buf,
                                           int off,
                                           int maxLen)

Receive a broadcast datagram

Parameters:

lana - int

nameNum - int

buf - byte[]

off - int

maxLen - int

Returns:

int

Hangup

public static int Hangup(int lana,
                         int lsn)

Hangup a session

Parameters:

lsn - int

Returns:

int

GetLocalNetBIOSName

public static String GetLocalNetBIOSName()

Return the local computers NetBIOS name

Returns:

String

GetLocalDomainName

public static String GetLocalDomainName()

Return the local domain name

Returns:

String

getWINSServerList

public static String getWINSServerList()

Return a comma delimeted list of WINS server TCP/IP addresses, or null if no WINS servers are configured.

Returns:

String

getIPAddressForLANA

public static final String getIPAddressForLANA(int lana)

Find the TCP/IP address for a LANA

Parameters:

lana - int

Returns:

String

getAdapterNameForLANA

public static final String getAdapterNameForLANA(int lana)

Find the adapter name for a LANA

Parameters:

lana - int

Returns:

String

getLANAForIPAddress

public static final int getLANAForIPAddress(String addr)

Find the LANA for a TCP/IP address

Parameters:

addr - String

Returns:

int

getLANAForAdapterName

public static final int getLANAForAdapterName(String name)

Find the LANA for a network adapter

Parameters:

name - String

Returns:

int

InitializeSockets

protected static void InitializeSockets()
                                 throws WinsockNetBIOSException

Initialize the NetBIOS socket interface

Throws:

WinsockNetBIOSException - If a Winsock error occurs

ShutdownSockets

protected static void ShutdownSockets()

Shutdown the NetBIOS socket interface

CreateSocket

protected static int CreateSocket(int lana)
                           throws WinsockNetBIOSException

Create a NetBIOS socket

Parameters:

lana - int

Returns:

int

Throws:

WinsockNetBIOSException - If a Winsock error occurs

BindSocket

protected static int BindSocket(int sockPtr,
                                byte[] name)
                         throws WinsockNetBIOSException

Bind a NetBIOS socket to a name to listen for incoming sessions

Parameters:

sockPtr - int

name - byte[]

Throws:

WinsockNetBIOSException - If a Winsock error occurs

BindSocket

protected static int BindSocket(int sockPtr,
                                byte[] name,
                                boolean fastAddName)
                         throws WinsockNetBIOSException

Bind a NetBIOS socket to a name to listen for incoming sessions

Parameters:

sockPtr - int

name - byte[]

fastAddName - boolean

Throws:

WinsockNetBIOSException - If a Winsock error occurs

ListenSocket

protected static int ListenSocket(int sockPtr,
                                  byte[] callerName)
                           throws WinsockNetBIOSException

Listen for an incoming connection

Parameters:

sockPtr - int

callerName - byte[]

Returns:

int

Throws:

WinsockNetBIOSException - If a Winsock error occurs

ConnectSocket

protected static void ConnectSocket(int sockPtr,
                                    byte[] remoteName)
                             throws WinsockNetBIOSException

Connect to a remote server

Parameters:

sockPtr - int

remoteName - byte[]

Throws:

WinsockNetBIOSException - If a Winsock error occurs

CloseSocket

protected static void CloseSocket(int sockPtr)

Close a NetBIOS socket

Parameters:

sockPtr - int

SendSocket

protected static int SendSocket(int sockPtr,
                                byte[] buf,
                                int off,
                                int len)
                         throws WinsockNetBIOSException

Send data on a session socket

Parameters:

sockPtr - int

buf - byte[]

off - int

len - int

Returns:

int

Throws:

WinsockNetBIOSException - If a Winsock error occurs

ReceiveSocket

protected static int ReceiveSocket(int sockPtr,
                                   byte[] buf,
                                   int off,
                                   int maxLen)
                            throws WinsockNetBIOSException

Receive data on a session socket

Parameters:

sockPtr - int

buf - byte[]

off - int

maxLen - int

Returns:

int

Throws:

WinsockNetBIOSException - If a Winsock error occurs

ReceiveLengthSocket

protected static int ReceiveLengthSocket(int sockPtr)
                                  throws WinsockNetBIOSException

Return the amount of receive data available on the socket

Parameters:

sockPtr - int

Returns:

int

Throws:

WinsockNetBIOSException - If a Winsock error occurs

SetNonBlockingSocket

protected static int SetNonBlockingSocket(int sockPtr,
                                          boolean nonBlocking)
                                   throws WinsockNetBIOSException

Configure a socket to be non-blocking

Parameters:

sockPtr - int

nonBlocking - boolean

Throws:

WinsockNetBIOSException - If a Winsock error occurs

SelectReceiveSockets

protected static int SelectReceiveSockets(int sockCnt,
                                          int[] readSocksIn,
                                          int[] readSocksOut)
                                   throws WinsockNetBIOSException

Wait for an event on one or more sockets

Parameters:

sockCnt - int

readSocksIn - int[]

readSocksOut - int[]

Returns:

int Count of sockets have triggered events

Throws:

WinsockNetBIOSException - If a Winsock error occurs

GetMaximumSocketsPerSelect

protected static int GetMaximumSocketsPerSelect()

Return the maximum number of sockets that can be configured per SelectSockets() call

Returns:

int

Win32CreateEvent

public static int Win32CreateEvent()
                            throws Exception

Create a Win32 event

Returns:

int

Throws:

Exception

Win32CloseEvent

public static void Win32CloseEvent(int eventHandle)
                            throws Exception

Close a Win32 event

Parameters:

eventHandle - int

Throws:

Exception

Win32SetEvent

public static boolean Win32SetEvent(int eventHandle)

Set a Win32 event

Parameters:

eventHandle - int

Returns:

boolean

Win32ResetEvent

public static boolean Win32ResetEvent(int eventHandle)

Reset a Win32 event

Parameters:

eventHandle - int

Returns:

boolean

WinsockCreateEvent

public static int WinsockCreateEvent()
                              throws WinsockNetBIOSException

Create a Winsock event

Returns:

int

Throws:

WinsockNetBIOSException

WinsockSetEvent

public static boolean WinsockSetEvent(int eventHandle)

Set a Winsock event

Parameters:

eventHandle - int

Returns:

boolean

WinsockResetEvent

public static boolean WinsockResetEvent(int eventHandle)

Reset a Winsock event

Parameters:

eventHandle - int

Returns:

boolean

WinsockCloseEvent

public static void WinsockCloseEvent(int eventHandle)
                              throws WinsockNetBIOSException

Close a Winsock event

Parameters:

eventHandle - int

Throws:

WinsockNetBIOSException

WinsockWaitForMultipleEvents

public static int WinsockWaitForMultipleEvents(int eventCnt,
                                               int[] events,
                                               boolean waitAll,
                                               int timeout,
                                               boolean alertable)
                                        throws WinsockNetBIOSException

Wait for Winsock events

Parameters:

eventCnt - int

events - int[]

waitAll - boolean

timeout - int

alertable - boolean

Returns:

int

Throws:

WinsockNetBIOSException

WinsockEventSelect

public static void WinsockEventSelect(int sockPtr,
                                      int eventHandle,
                                      int eventMask)
                               throws WinsockNetBIOSException

Set Winsock events for a socket

Parameters:

sockPtr - int

eventHandle - int

eventMask - int

Throws:

WinsockNetBIOSException

WinsockEnumNetworkEvents

public static int WinsockEnumNetworkEvents(int sockPtr,
                                           int eventHandle)
                                    throws WinsockNetBIOSException

Get the list of socket events that have triggered for a particular socket

Parameters:

sockPtr - int

eventHandle - int

Returns:

int

Throws:

WinsockNetBIOSException

getSocketReceiveBufferSize

public static int getSocketReceiveBufferSize(int sockPtr)
                                      throws WinsockNetBIOSException

Get the current receive buffer size for the socket

Parameters:

sockPtr - int

Returns:

int

Throws:

WinsockNetBIOSException

setSocketReceiveBufferSize

public static void setSocketReceiveBufferSize(int sockPtr,
                                              int bufSize)
                                       throws WinsockNetBIOSException

Set the socket receive buffer size

Parameters:

sockPtr - int

bufSize - int

Throws:

WinsockNetBIOSException

getSocketSendBufferSize

public static int getSocketSendBufferSize(int sockPtr)
                                   throws WinsockNetBIOSException

Get the current send buffer size for the socket

Parameters:

sockPtr - int

Returns:

int

Throws:

WinsockNetBIOSException

setSocketSendBufferSize

public static void setSocketSendBufferSize(int sockPtr,
                                           int bufSize)
                                    throws WinsockNetBIOSException

Set the socket send buffer size

Parameters:

sockPtr - int

bufSize - int

Throws:

WinsockNetBIOSException

waitForNetworkAddressChange

public static void waitForNetworkAddressChange()

Wait for a network address change event, block until a change occurs or the Winsock NetBIOS interface is shut down