com.zebra.rfid.api3

Class RFIDReader

java.lang.Object

com.zebra.rfid.api3.RFIDReader

public class RFIDReader
extends java.lang.Object

Provides the RFIDReader object.

Field Summary

Fields

Modifier and Type	Field and Description
Actions	Actions Instance of Actions Class for all Actions related Operation like Inventory,Access.
Config	Config Instance of Config Class for all Config related Operations
Events	Events Instance of Event Class for all Event related Operations
ReaderCapabilities	ReaderCapabilities Access the Reader Capabilities
com.zebra.rfid.api3.SecureConnectionInfo	SecureConnectionInfo

Constructor Summary

Constructors

Constructor and Description
RFIDReader() The constructor
RFIDReader(java.lang.String hostName, int port, int timeoutMilliseconds) Constructor takes host name or IP address, port and timeout as parameter
RFIDReader(java.lang.String hostName, int port, int timeoutMilliseconds, java.lang.String Protocol, java.lang.String Transport) Constructor takes host name or IP address, port and timeout as parameter

Method Summary

Modifier and Type	Method and Description
void	AcceptConnection(long readerSocket)
void	connect() Connects to the reader
void	disconnect() Disconnect from the reader
void	Dispose() Disposes the RFIDReader
protected void	finalize()
java.lang.String	getHostName() Gets the host name or IP Address of the reader
java.lang.String	getPassword()
int	getPort() Gets the port number which is used for establishing connection with the reader
int	getTimeout() Gets the timeout of the reader connection
boolean	isCapabilitiesReceived() Returns the current reader capabilities status
boolean	isConnected() Returns the current reader connection status
void	PostConnectReaderUpdate() Update reader caps and init again in case of region and batch mode and password scenarios
void	reconnect() Reconnects to the reader, if the connection is lost.
void	setHostName(java.lang.String hostName) Sets the host name or IP Address of the reader
void	setPassword(java.lang.String password)
void	setPort(int port) Sets the port number which is used for establishing connection with the reader.
void	setTimeout(int timeout) Sets the Time out for the response from the Reader, if specified zero(0), the default time out 5000 (5sec) will be used.
VersionInfo	versionInfo() Gets the RFID class library version information

Methods inherited from class java.lang.Object

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

Field Detail

SecureConnectionInfo

public com.zebra.rfid.api3.SecureConnectionInfo SecureConnectionInfo

Config

public Config Config

Instance of Config Class for all Config related Operations

Actions

public Actions Actions

Instance of Actions Class for all Actions related Operation like Inventory,Access.

Events

public Events Events

Instance of Event Class for all Event related Operations

ReaderCapabilities

public ReaderCapabilities ReaderCapabilities

Access the Reader Capabilities

Constructor Detail

RFIDReader

public RFIDReader()

The constructor

RFIDReader

public RFIDReader(java.lang.String hostName,
                  int port,
                  int timeoutMilliseconds)

Constructor takes host name or IP address, port and timeout as parameter

Parameters:

hostName - String containing the reader's Host name or IP Address of the Reader.

port - Reader Port number, if specified as Zero (0), the default port 5084 will be used

timeoutMilliseconds - Time out for the response from the Reader, if specified zero(0), the default time out 5000 (5sec) will be used. The lowest possible value could be 2sec. This value also translates to keep-alive timeout. If the connection to the reader was inactive (no keep-alive message from the Reader) for a time greater than 10 times the timeout, DISCONNECTION_EVENT will be triggered to the application, if the application has registered for the same.

RFIDReader

public RFIDReader(java.lang.String hostName,
                  int port,
                  int timeoutMilliseconds,
                  java.lang.String Protocol,
                  java.lang.String Transport)

Constructor takes host name or IP address, port and timeout as parameter

Parameters:

hostName - String containing the reader's Host name or IP Address of the Reader.

port - Reader Port number, if specified as Zero (0), the default port 5084 will be used

timeoutMilliseconds - Time out for the response from the Reader, if specified zero(0), the default time out 5000 (5sec) will be used. The lowest possible value could be 2sec. This value also translates to keep-alive timeout. If the connection to the reader was inactive (no keep-alive message from the Reader) for a time greater than 10 times the timeout, DISCONNECTION_EVENT will be triggered to the application, if the application has registered for the same.

Protocol - Reader

Transport - Reader

Method Detail

PostConnectReaderUpdate

public void PostConnectReaderUpdate()
                             throws InvalidUsageException,
                                    OperationFailureException

Update reader caps and init again in case of region and batch mode and password scenarios

Throws:

InvalidUsageException

OperationFailureException

finalize

protected void finalize()
                 throws InvalidUsageException,
                        OperationFailureException

Overrides:

finalize in class java.lang.Object

Throws:

InvalidUsageException

OperationFailureException

Dispose

public void Dispose()
             throws java.lang.Exception

Disposes the RFIDReader

Throws:

java.lang.Exception

getPort

public int getPort()

Gets the port number which is used for establishing connection with the reader

setPort

public void setPort(int port)

Sets the port number which is used for establishing connection with the reader. If Zero(0) specified, the default port 5084 will be used

getTimeout

public int getTimeout()

Gets the timeout of the reader connection

setTimeout

public void setTimeout(int timeout)

Sets the Time out for the response from the Reader, if specified zero(0), the default time out 5000 (5sec) will be used. The lowest possible value could be 2sec. This value also translates to keep-alive timeout. If the connection to the reader was inactive (no keep-alive message from the Reader) for a time greater than 10 times the timeout, DISCONNECTION_EVENT will be triggered to the application, if the application has registered for the same.

getHostName

public java.lang.String getHostName()

Gets the host name or IP Address of the reader

setHostName

public void setHostName(java.lang.String hostName)

Sets the host name or IP Address of the reader

getPassword

public java.lang.String getPassword()

setPassword

public void setPassword(java.lang.String password)

isConnected

public boolean isConnected()

Returns the current reader connection status

isCapabilitiesReceived

public boolean isCapabilitiesReceived()

Returns the current reader capabilities status

versionInfo

public VersionInfo versionInfo()
                        throws InvalidUsageException

Gets the RFID class library version information

Returns:

Throws:

InvalidUsageException

connect

public void connect()
             throws InvalidUsageException,
                    OperationFailureException

Connects to the reader

Throws:

InvalidUsageException

OperationFailureException

AcceptConnection

public void AcceptConnection(long readerSocket)
                      throws InvalidUsageException,
                             OperationFailureException

Throws:

InvalidUsageException

OperationFailureException

reconnect

public void reconnect()
               throws InvalidUsageException,
                      OperationFailureException

Reconnects to the reader, if the connection is lost.

Throws:

InvalidUsageException

OperationFailureException

disconnect

public void disconnect()
                throws InvalidUsageException,
                       OperationFailureException

Disconnect from the reader

Throws:

InvalidUsageException

OperationFailureException