asyn  4-34
Public Member Functions | Protected Attributes | List of all members
asynPortClient Class Reference

Base class for asyn port clients; handles most of the bookkeeping for writing an asyn port client with standard asyn interfaces. More...

#include <asynPortClient.h>

Inheritance diagram for asynPortClient:
asynCommonClient asynEnumClient asynFloat32ArrayClient asynFloat64ArrayClient asynFloat64Client asynGenericPointerClient asynInt16ArrayClient asynInt32ArrayClient asynInt32Client asynInt8ArrayClient asynOctetClient asynOptionClient asynUInt32DigitalClient

Public Member Functions

 asynPortClient (const char *portName, int addr, const char *asynInterfaceType, const char *drvInfo, double timeout)
 Constructor for asynPortClient class. More...
 
virtual ~asynPortClient ()
 Destructor for asynPortClient class Frees all allocated resources. More...
 
void setTimeout (double timeout)
 
void report (FILE *fp, int details)
 Reports the properties of this client. More...
 

Protected Attributes

asynUser * pasynUser_
 
asynUser * pasynUserSyncIO_
 
asynInterface * pasynInterface_
 
double timeout_
 
char * portName_
 
int addr_
 
char * asynInterfaceType_
 
char * drvInfo_
 
void * drvPvt
 
void * interruptPvt_
 

Detailed Description

Base class for asyn port clients; handles most of the bookkeeping for writing an asyn port client with standard asyn interfaces.

Constructor & Destructor Documentation

asynPortClient::asynPortClient ( const char *  portName,
int  addr,
const char *  asynInterfaceType,
const char *  drvInfo,
double  timeout 
)

Constructor for asynPortClient class.

Parameters
[in]portNameThe name of the asyn port to connect to
[in]addrThe address on the asyn port to connect to
[in]asynInterfaceTypeThe name of the asynInterface to connect to (e.g.asynInt32, asynOctet, etc.)
[in]drvInfoThe drvInfo string to identify which property of the port is being connected to
[in]timeoutThe default timeout for all communications between the client and the port driver
asynPortClient::~asynPortClient ( )
virtual

Destructor for asynPortClient class Frees all allocated resources.

Member Function Documentation

void asynPortClient::report ( FILE *  fp,
int  details 
)

Reports the properties of this client.

void asynPortClient::setTimeout ( double  timeout)
inline

Member Data Documentation

int asynPortClient::addr_
protected
char* asynPortClient::asynInterfaceType_
protected
char* asynPortClient::drvInfo_
protected
void* asynPortClient::drvPvt
protected
void* asynPortClient::interruptPvt_
protected
asynInterface* asynPortClient::pasynInterface_
protected
asynUser* asynPortClient::pasynUser_
protected
asynUser* asynPortClient::pasynUserSyncIO_
protected
char* asynPortClient::portName_
protected
double asynPortClient::timeout_
protected

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