asynInt8ArrayClient Class Reference

Class for asyn port clients to communicate on the asynInt8Array interface. More...

#include <asynPortClient.h>

Inheritance diagram for asynInt8ArrayClient:

Public Member Functions
	asynInt8ArrayClient (const char *portName, int addr, const char *drvInfo, double timeout=DEFAULT_TIMEOUT)
	Constructor for asynInt8Array class. More...
	asynInt8ArrayClient (const char *portName, const char *drvInfo, int addr=0, double timeout=DEFAULT_TIMEOUT)
virtual	~asynInt8ArrayClient ()
	Destructor for asynInt8Array class. More...
virtual asynStatus	read (epicsInt8 *value, size_t nElements, size_t *nIn)
	Reads an epicsInt8 array from the port driver. More...
virtual asynStatus	write (epicsInt8 *value, size_t nElements)
	Writes an epicsInt8 array to the port driver. More...
virtual asynStatus	registerInterruptUser (interruptCallbackInt8Array pCallback, void *userPvt=0)
	Registers an interruptCallbackInt8Array function that the driver will call when there is a new value. More...
Public Member Functions inherited from asynParamClient
	asynParamClient (const char *portName, int addr, const char *asynInterfaceType, const char *drvInfo, double timeout)
	Constructor for asynParamClient class. More...
virtual	~asynParamClient ()
	Destructor for asynParamClient class Frees all allocated resources. More...
void	setTimeout (double timeout)
void	report (FILE *fp, int details)
	Reports the properties of this client. More...
char *	getPortName ()
char *	getAsynInterfaceType ()

Additional Inherited Members
Protected Attributes inherited from asynParamClient
asynUser *	pasynUser_
asynUser *	pasynUserSyncIO_
asynInterface *	pasynInterface_
double	timeout_
char *	portName_
int	addr_
char *	asynInterfaceType_
char *	drvInfo_
void *	drvPvt
void *	interruptPvt_

Detailed Description

Class for asyn port clients to communicate on the asynInt8Array interface.

Constructor & Destructor Documentation

asynInt8ArrayClient() [1/2]

asynInt8ArrayClient::asynInt8ArrayClient ( const char *  portName, int  addr, const char *  drvInfo, double  timeout = DEFAULT_TIMEOUT  )

inline

Constructor for asynInt8Array class.

Parameters

[in]	portName	The name of the asyn port to connect to
[in]	addr	The address on the asyn port to connect to
[in]	drvInfo	The drvInfo string to identify which property of the port is being connected to
[in]	timeout	The default timeout for all communications between the client and the port driver

asynInt8ArrayClient() [2/2]

asynInt8ArrayClient::asynInt8ArrayClient ( const char *  portName, const char *  drvInfo, int  addr = 0, double  timeout = DEFAULT_TIMEOUT  )

inline

~asynInt8ArrayClient()

virtual asynInt8ArrayClient::~asynInt8ArrayClient ( )

inlinevirtual

Destructor for asynInt8Array class.

Disconnects from port, frees resources.

Member Function Documentation

read()

virtual asynStatus asynInt8ArrayClient::read ( epicsInt8 *  value, size_t  nElements, size_t *  nIn  )

inlinevirtual

Reads an epicsInt8 array from the port driver.

Parameters

[out]	value	The array to read from the port driver
[in]	nElements	The number of elements in the array
[out]	nIn	The number of array elements actual read

registerInterruptUser()

virtual asynStatus asynInt8ArrayClient::registerInterruptUser ( interruptCallbackInt8Array  pCallback, void *  userPvt = 0  )

inlinevirtual

Registers an interruptCallbackInt8Array function that the driver will call when there is a new value.

Parameters

[in]	pCallback	The address of the callback function
[in]	userPvt	The user-defined pointer to be passed to the callback function

write()

virtual asynStatus asynInt8ArrayClient::write ( epicsInt8 *  value, size_t  nElements  )

inlinevirtual

Writes an epicsInt8 array to the port driver.

Parameters

[in]	value	The array to write to the port driver
[in]	nElements	The number of elements in the array

---

The documentation for this class was generated from the following file:

• /home/runner/work/asyn/asyn/asyn/asynPortClient/asynPortClient.h