Instrument Neutral Distributed Interface INDI  1.6.0
Public Member Functions | Protected Member Functions | List of all members
MyClient Class Reference

#include <tutorial_client.h>

Inheritance diagram for MyClient:
INDI::BaseClient INDI::BaseMediator

Public Member Functions

 MyClient ()
 
 ~MyClient ()=default
 
void setTemperature ()
 
void takeExposure ()
 
- Public Member Functions inherited from INDI::BaseClient
 BaseClient ()
 
virtual ~BaseClient ()
 
void setServer (const char *hostname, unsigned int port)
 Set the server host name and port. More...
 
void watchDevice (const char *deviceName)
 Add a device to the watch list. More...
 
bool connectServer ()
 Connect to INDI server. More...
 
bool disconnectServer ()
 Disconnect from INDI server. More...
 
bool isServerConnected () const
 
void connectDevice (const char *deviceName)
 Connect to INDI driver. More...
 
void disconnectDevice (const char *deviceName)
 Disconnect INDI driver. More...
 
INDI::BaseDevicegetDevice (const char *deviceName)
 
const std::vector< INDI::BaseDevice * > & getDevices () const
 
bool getDevices (std::vector< INDI::BaseDevice * > &deviceList, uint16_t driverInterface)
 getDevices Returns list of devices that belong to a particular DRIVER_INTERFACE class. More...
 
void setBLOBMode (BLOBHandling blobH, const char *dev, const char *prop=NULL)
 Set Binary Large Object policy mode. More...
 
BLOBHandling getBLOBMode (const char *dev, const char *prop=NULL)
 getBLOBMode Get Binary Large Object policy mode IF set previously by setBLOBMode More...
 
const char * getHost ()
 
int getPort ()
 
void sendNewText (ITextVectorProperty *pp)
 Send new Text command to server. More...
 
void sendNewText (const char *deviceName, const char *propertyName, const char *elementName, const char *text)
 Send new Text command to server. More...
 
void sendNewNumber (INumberVectorProperty *pp)
 Send new Number command to server. More...
 
void sendNewNumber (const char *deviceName, const char *propertyName, const char *elementName, double value)
 Send new Number command to server. More...
 
void sendNewSwitch (ISwitchVectorProperty *pp)
 Send new Switch command to server. More...
 
void sendNewSwitch (const char *deviceName, const char *propertyName, const char *elementName)
 Send new Switch command to server. More...
 
void startBlob (const char *devName, const char *propName, const char *timestamp)
 Send opening tag for BLOB command to server. More...
 
void sendOneBlob (IBLOB *bp)
 Send ONE blob content to server. The BLOB data in raw binary format and will be converted to base64 and sent to server. More...
 
void sendOneBlob (const char *blobName, unsigned int blobSize, const char *blobFormat, void *blobBuffer)
 Send ONE blob content to server. The BLOB data in raw binary format and will be converted to base64 and sent to server. More...
 
void finishBlob ()
 Send closing tag for BLOB command to server. More...
 
void setVerbose (bool enable)
 setVerbose Set verbose mode More...
 
bool isVerbose () const
 isVerbose Is client in verbose mode? More...
 
void setConnectionTimeout (uint32_t seconds, uint32_t microseconds)
 setConnectionTimeout Set connection timeout. By default it is 3 seconds. More...
 
- Public Member Functions inherited from INDI::BaseMediator
virtual ~BaseMediator ()
 

Protected Member Functions

virtual void newDevice (INDI::BaseDevice *dp)
 Emmited when a new device is created from INDI server. More...
 
virtual void removeDevice (INDI::BaseDevice *)
 Emmited when a device is deleted from INDI server. More...
 
virtual void newProperty (INDI::Property *property)
 Emmited when a new property is created for an INDI driver. More...
 
virtual void removeProperty (INDI::Property *)
 Emmited when a property is deleted for an INDI driver. More...
 
virtual void newBLOB (IBLOB *bp)
 Emmited when a new BLOB value arrives from INDI server. More...
 
virtual void newSwitch (ISwitchVectorProperty *)
 Emmited when a new switch value arrives from INDI server. More...
 
virtual void newNumber (INumberVectorProperty *nvp)
 Emmited when a new number value arrives from INDI server. More...
 
virtual void newMessage (INDI::BaseDevice *dp, int messageID)
 Emmited when a new message arrives from INDI server. More...
 
virtual void newText (ITextVectorProperty *)
 Emmited when a new text value arrives from INDI server. More...
 
virtual void newLight (ILightVectorProperty *)
 Emmited when a new light value arrives from INDI server. More...
 
virtual void serverConnected ()
 Emmited when the server is connected. More...
 
virtual void serverDisconnected (int)
 Emmited when the server gets disconnected. More...
 
- Protected Member Functions inherited from INDI::BaseClient
int dispatchCommand (XMLEle *root, char *errmsg)
 Dispatch command received from INDI server to respective devices handled by the client. More...
 
int deleteDevice (const char *devName, char *errmsg)
 Remove device. More...
 
int delPropertyCmd (XMLEle *root, char *errmsg)
 Delete property command. More...
 
INDI::BaseDevicefindDev (const char *devName, char *errmsg)
 Find and return a particular device. More...
 
INDI::BaseDeviceaddDevice (XMLEle *dep, char *errmsg)
 Add a new device. More...
 
INDI::BaseDevicefindDev (XMLEle *root, int create, char *errmsg)
 Find a device, and if it doesn't exist, create it if create is set to 1. More...
 
int messageCmd (XMLEle *root, char *errmsg)
 
virtual void newUniversalMessage (std::string message)
 newUniversalMessage Universal messages are sent from INDI server without a specific device. It is addressed to the client overall. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from INDI::BaseClient
static void * listenHelper (void *context)
 

Detailed Description

Examples:
tutorial_client.cpp, and tutorial_client.h.

Definition at line 39 of file tutorial_client.h.

Constructor & Destructor Documentation

MyClient::MyClient ( )
Examples:
tutorial_client.cpp, and tutorial_client.h.

Definition at line 72 of file tutorial_client.cpp.

MyClient::~MyClient ( )
default
Examples:
tutorial_client.h.

Member Function Documentation

void MyClient::newBLOB ( IBLOB bp)
protectedvirtual

Emmited when a new BLOB value arrives from INDI server.

Parameters
bpPointer to filled and process BLOB.

Implements INDI::BaseMediator.

Examples:
tutorial_client.cpp, and tutorial_client.h.

Definition at line 183 of file tutorial_client.cpp.

void MyClient::newDevice ( INDI::BaseDevice dp)
protectedvirtual

Emmited when a new device is created from INDI server.

Parameters
dpPointer to the base device instance

Implements INDI::BaseMediator.

Examples:
tutorial_client.cpp, and tutorial_client.h.

Definition at line 120 of file tutorial_client.cpp.

virtual void MyClient::newLight ( ILightVectorProperty lvp)
inlineprotectedvirtual

Emmited when a new light value arrives from INDI server.

Parameters
lvpPointer to a light vector property.

Implements INDI::BaseMediator.

Examples:
tutorial_client.h.

Definition at line 58 of file tutorial_client.h.

void MyClient::newMessage ( INDI::BaseDevice dp,
int  messageID 
)
protectedvirtual

Emmited when a new message arrives from INDI server.

Parameters
dppointer to the INDI device the message is sent to.
messageIDID of the message that can be used to retrieve the message from the device's messageQueue() function.

Implements INDI::BaseMediator.

Examples:
tutorial_client.cpp, and tutorial_client.h.

Definition at line 171 of file tutorial_client.cpp.

void MyClient::newNumber ( INumberVectorProperty nvp)
protectedvirtual

Emmited when a new number value arrives from INDI server.

Parameters
nvpPointer to a number vector property.

Implements INDI::BaseMediator.

Examples:
tutorial_client.cpp, and tutorial_client.h.

Definition at line 153 of file tutorial_client.cpp.

void MyClient::newProperty ( INDI::Property property)
protectedvirtual

Emmited when a new property is created for an INDI driver.

Parameters
propertyPointer to the Property Container

Implements INDI::BaseMediator.

Examples:
tutorial_client.cpp, and tutorial_client.h.

Definition at line 131 of file tutorial_client.cpp.

virtual void MyClient::newSwitch ( ISwitchVectorProperty svp)
inlineprotectedvirtual

Emmited when a new switch value arrives from INDI server.

Parameters
svpPointer to a switch vector property.

Implements INDI::BaseMediator.

Examples:
tutorial_client.h.

Definition at line 54 of file tutorial_client.h.

virtual void MyClient::newText ( ITextVectorProperty tvp)
inlineprotectedvirtual

Emmited when a new text value arrives from INDI server.

Parameters
tvpPointer to a text vector property.

Implements INDI::BaseMediator.

Examples:
tutorial_client.h.

Definition at line 57 of file tutorial_client.h.

virtual void MyClient::removeDevice ( INDI::BaseDevice dp)
inlineprotectedvirtual

Emmited when a device is deleted from INDI server.

Parameters
dpPointer to the base device instance.

Implements INDI::BaseMediator.

Examples:
tutorial_client.h.

Definition at line 50 of file tutorial_client.h.

virtual void MyClient::removeProperty ( INDI::Property property)
inlineprotectedvirtual

Emmited when a property is deleted for an INDI driver.

Parameters
propertyPointer to the Property Container to remove.

Implements INDI::BaseMediator.

Examples:
tutorial_client.h.

Definition at line 52 of file tutorial_client.h.

virtual void MyClient::serverConnected ( )
inlineprotectedvirtual

Emmited when the server is connected.

Implements INDI::BaseMediator.

Examples:
tutorial_client.h.

Definition at line 59 of file tutorial_client.h.

virtual void MyClient::serverDisconnected ( int  exit_code)
inlineprotectedvirtual

Emmited when the server gets disconnected.

Parameters
exit_code0 if client was requested to disconnect from server. -1 if connection to server is terminated due to remote server disconnection.

Implements INDI::BaseMediator.

Examples:
tutorial_client.h.

Definition at line 60 of file tutorial_client.h.

void MyClient::setTemperature ( )
Examples:
tutorial_client.cpp, and tutorial_client.h.

Definition at line 80 of file tutorial_client.cpp.

void MyClient::takeExposure ( )
Examples:
tutorial_client.cpp, and tutorial_client.h.

Definition at line 99 of file tutorial_client.cpp.


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