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

#include <LoaderClient.h>

Inheritance diagram for LoaderClient:
INDI::BaseClient INDI::AlignmentSubsystem::AlignmentSubsystemForClients INDI::BaseMediator

Public Member Functions

 LoaderClient ()
 
virtual ~LoaderClient ()
 
void Initialise (int argc, char *argv[])
 
void Load ()
 
- 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...
 
const char * getHost () const
 Get the server host name. More...
 
int getPort () const
 Get the port number. More...
 
bool connectServer ()
 Connect to INDI server. More...
 
bool disconnectServer (int exit_code=0)
 Disconnect from INDI server. More...
 
bool isServerConnected () const
 Get status of the connection. More...
 
void setConnectionTimeout (uint32_t seconds, uint32_t microseconds)
 setConnectionTimeout Set connection timeout. By default it is 3 seconds. More...
 
void serverDisconnected (int exit_code) override
 Emmited when the server gets disconnected. More...
 
void setVerbose (bool enable)
 setVerbose Set verbose mode More...
 
bool isVerbose () const
 isVerbose Is client in verbose mode? More...
 
void watchProperty (const char *deviceName, const char *propertyName)
 watchProperties Add a property to the watch list. When communicating with INDI server. More...
 
void watchDevice (const char *deviceName)
 Add a device to the watch list. More...
 
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=nullptr)
 Set Binary Large Object policy mode. More...
 
BLOBHandling getBLOBMode (const char *dev, const char *prop=nullptr)
 getBLOBMode Get Binary Large Object policy mode IF set previously by setBLOBMode More...
 
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...
 
- Public Member Functions inherited from INDI::BaseMediator
virtual ~BaseMediator ()=default
 
virtual void removeDevice (INDI::BaseDevice *dp)=0
 Emmited when a device is deleted from INDI server. More...
 

Protected Member Functions

virtual void newBLOB (IBLOB *bp)
 Emmited when a new BLOB value arrives from INDI server. More...
 
virtual void newDevice (INDI::BaseDevice *dp)
 Emmited when a new device is created from INDI server. More...
 
virtual void newLight (ILightVectorProperty *lvp)
 Emmited when a new light 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 newNumber (INumberVectorProperty *nvp)
 Emmited when a new number value arrives from INDI server. More...
 
virtual void newProperty (INDI::Property *property)
 Emmited when a new property is created for an INDI driver. More...
 
virtual void newSwitch (ISwitchVectorProperty *svp)
 Emmited when a new switch value arrives from INDI server. More...
 
virtual void newText (ITextVectorProperty *tvp)
 Emmited when a new text value arrives from INDI server. More...
 
virtual void removeProperty (INDI::Property *property)
 Emmited when a property is deleted for an INDI driver. More...
 
virtual void serverConnected ()
 Emmited when the server is connected. More...
 
virtual void serverDisconnected (int exit_code)
 Emmited when the server gets disconnected. More...
 
- Protected Member Functions inherited from INDI::BaseClient
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

- Protected Attributes inherited from INDI::BaseClient
std::unique_ptr< INDI::BaseClientPrivated_ptr
 

Detailed Description

Definition at line 9 of file LoaderClient.h.

Constructor & Destructor Documentation

◆ LoaderClient()

LoaderClient::LoaderClient ( )

Definition at line 8 of file LoaderClient.cpp.

◆ ~LoaderClient()

LoaderClient::~LoaderClient ( )
virtual

Definition at line 13 of file LoaderClient.cpp.

Member Function Documentation

◆ Initialise()

void LoaderClient::Initialise ( int  argc,
char *  argv[] 
)

Definition at line 20 of file LoaderClient.cpp.

◆ Load()

void LoaderClient::Load ( )

Definition at line 46 of file LoaderClient.cpp.

◆ newBLOB()

void LoaderClient::newBLOB ( IBLOB bp)
protectedvirtual

Emmited when a new BLOB value arrives from INDI server.

Parameters
bpPointer to filled and process BLOB.

Implements INDI::BaseMediator.

Definition at line 65 of file LoaderClient.cpp.

◆ newDevice()

void LoaderClient::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.

Definition at line 70 of file LoaderClient.cpp.

◆ newLight()

virtual void LoaderClient::newLight ( ILightVectorProperty lvp)
inlineprotectedvirtual

Emmited when a new light value arrives from INDI server.

Parameters
lvpPointer to a light vector property.

Implements INDI::BaseMediator.

Definition at line 25 of file LoaderClient.h.

◆ newMessage()

virtual void LoaderClient::newMessage ( INDI::BaseDevice dp,
int  messageID 
)
inlineprotectedvirtual

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.

Definition at line 26 of file LoaderClient.h.

◆ newNumber()

void LoaderClient::newNumber ( INumberVectorProperty nvp)
protectedvirtual

Emmited when a new number value arrives from INDI server.

Parameters
nvpPointer to a number vector property.

Implements INDI::BaseMediator.

Definition at line 75 of file LoaderClient.cpp.

◆ newProperty()

void LoaderClient::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.

Definition at line 80 of file LoaderClient.cpp.

◆ newSwitch()

void LoaderClient::newSwitch ( ISwitchVectorProperty svp)
protectedvirtual

Emmited when a new switch value arrives from INDI server.

Parameters
svpPointer to a switch vector property.

Implements INDI::BaseMediator.

Definition at line 85 of file LoaderClient.cpp.

◆ newText()

virtual void LoaderClient::newText ( ITextVectorProperty tvp)
inlineprotectedvirtual

Emmited when a new text value arrives from INDI server.

Parameters
tvpPointer to a text vector property.

Implements INDI::BaseMediator.

Definition at line 30 of file LoaderClient.h.

◆ removeProperty()

virtual void LoaderClient::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.

Definition at line 31 of file LoaderClient.h.

◆ serverConnected()

virtual void LoaderClient::serverConnected ( )
inlineprotectedvirtual

Emmited when the server is connected.

Implements INDI::BaseMediator.

Definition at line 32 of file LoaderClient.h.

◆ serverDisconnected()

virtual void LoaderClient::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.

Definition at line 33 of file LoaderClient.h.


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