com.cloudpos.msr

Interface MSRDevice

All Superinterfaces:

Device, TimeConstants

public interface MSRDevice
extends Device, TimeConstants

The MSRDevice interface defines the API for interacting with Magnetic Stripe Reader (MSR) devices. This interface allows applications to control the MSR device and read data from magnetic stripe cards.

An instance of MSRDevice is obtained as follows:

 MSRDevice msrDevice = (MSRDevice) POSTerminal.getInstance().getDevice("com.cloudpos.device.msr");
 

The identifier "com.cloudpos.device.msr" is used to specify the MSR device in the specific implementation.

Applications must request permission to access the MSR device:

 <uses-permission android:name="android.permission.CLOUDPOS_MSR"/> 

See Also:

Device

Field Summary

Fields inherited from interface com.cloudpos.TimeConstants

FOREVER, IMMEDIATE, MilliSECOND, SECOND

Method Summary

Modifier and Type	Method and Description
void	listenForSwipe(OperationListener listener, int timeout) Initiates an asynchronous operation to read data from selected tracks of a swiped card.
void	open(int logicalID) Opens a connection to the MSR device using a specified logical ID.
MSROperationResult	waitForSwipe(int timeout) A synchronous version of listenForSwipe(OperationListener, int).

Methods inherited from interface com.cloudpos.Device

cancelRequest, close, getFailCount, getUsageCount, open

Method Detail

open

void open(int logicalID)
   throws DeviceException

Opens a connection to the MSR device using a specified logical ID.

Parameters:

logicalID - The logical ID of the MSR device.

Throws:

DeviceException - for standard reasons as documented in DeviceException.

listenForSwipe

void listenForSwipe(OperationListener listener,
                    int timeout)
             throws DeviceException

Initiates an asynchronous operation to read data from selected tracks of a swiped card. This method reinitializes any existing card data buffer before waiting for a new card swipe. The result is delivered to the provided OperationListener. On successful execution, the read data can be retrieved from the MSROperationResult using its getMSCardData method.

This method supports timeout management; hence, the device must be capable of responding to cancelRequest() to abort the operation if necessary. In case of a timeout, the result will contain an error code OperationResult.ERR_TIMEOUT.

Parameters:

listener - The listener to handle operation results.

timeout - Maximum time to wait for a card swipe, in milliseconds. Special values: TimeConstants.FOREVER for indefinite waiting, TimeConstants.IMMEDIATE for immediate input reading.

Throws:

DeviceException - for standard reasons as documented in DeviceException.

See Also:

OperationListener.handleResult(com.cloudpos.OperationResult), MSROperationResult, MSRTrackData

waitForSwipe

MSROperationResult waitForSwipe(int timeout)
                         throws DeviceException

A synchronous version of listenForSwipe(OperationListener, int). Blocks the calling thread until data is received, the operation times out, or it is canceled.

Parameters:

timeout - Maximum time to wait for a card swipe, in milliseconds. Special values: TimeConstants.FOREVER for indefinite waiting, TimeConstants.IMMEDIATE for immediate input reading.

Returns:

The result of the swipe operation.

Throws:

DeviceException - for standard reasons as documented in DeviceException.