 |
openDAQ
Open data acquisition platform
|
| |
|
openDAQ
Open data acquisition platform
|
|
| |
Represents a server. The server provides access to the openDAQ device. Depend of the implementation, it can support configuring the device, reading configuration, and data streaming. More...
Inheritance diagram for IServer: Collaboration diagram for IServer:Represents a server. The server provides access to the openDAQ device. Depend of the implementation, it can support configuring the device, reading configuration, and data streaming.
We do not make the server directly. But through the instance and module manager. For that reason, the server must be uniquely defined with "ServerType". The server is then created with the current root device, context and configuration object.
Configuration of the server can be done with custom property object. The configuration object is created with the corresponding ServerType object (IServerType::createDefaultConfig method). For example, with a configuration object, we can define connection timeout.
Public Member Functions | |
| virtual ErrCode INTERFACE_FUNC | stop ()=0 |
| Stops the server. This is called when we remove the server from the Instance or Instance is closing. | |
| virtual ErrCode INTERFACE_FUNC | getId (IString **serverId)=0 |
| Gets the server id. More... | |
| virtual ErrCode INTERFACE_FUNC | enableDiscovery ()=0 |
| Enables the server to be discovered by the clients. | |
| virtual ErrCode INTERFACE_FUNC | getSignals (IList **signals, ISearchFilter *searchFilter=nullptr)=0 |
| Gets a list of the server's signals. More... | |
| Public Member Functions inherited from IFolder | |
| virtual ErrCode INTERFACE_FUNC | getItems (IList **items, ISearchFilter *searchFilter=nullptr)=0 |
| Gets the list of the items in the folder. More... | |
| virtual ErrCode INTERFACE_FUNC | isEmpty (Bool *empty)=0 |
| Returns True if the folder is empty. More... | |
| virtual ErrCode INTERFACE_FUNC | hasItem (IString *localId, Bool *value)=0 |
| Returns True if the folder has an item with local ID. More... | |
| virtual ErrCode INTERFACE_FUNC | getItem (IString *localId, IComponent **item)=0 |
| Gets the item component with the specified localId. More... | |
| Public Member Functions inherited from IComponent | |
| virtual ErrCode INTERFACE_FUNC | getLocalId (IString **localId)=0 |
| Gets the local ID of the component. More... | |
| virtual ErrCode INTERFACE_FUNC | getGlobalId (IString **globalId)=0 |
| Gets the global ID of the component. More... | |
| virtual ErrCode INTERFACE_FUNC | getActive (Bool *active)=0 |
| Returns true if the component is active; false otherwise. More... | |
| virtual ErrCode INTERFACE_FUNC | setActive (Bool active)=0 |
Sets the component to be either active or inactive. Also recursively sets the active field of all child components if component is a folder. More... | |
| virtual ErrCode INTERFACE_FUNC | getContext (IContext **context)=0 |
| Gets the context object. More... | |
| virtual ErrCode INTERFACE_FUNC | getParent (IComponent **parent)=0 |
| Gets the parent of the component. More... | |
| virtual ErrCode INTERFACE_FUNC | getName (IString **name)=0 |
| Gets the name of the component. More... | |
| virtual ErrCode INTERFACE_FUNC | setName (IString *name)=0 |
| Sets the name of the component. More... | |
| virtual ErrCode INTERFACE_FUNC | getDescription (IString **description)=0 |
| Gets the description of the component. More... | |
| virtual ErrCode INTERFACE_FUNC | setDescription (IString *description)=0 |
| Sets the description of the component. More... | |
| virtual ErrCode INTERFACE_FUNC | getTags (ITags **tags)=0 |
| Gets the tags of the component. More... | |
| virtual ErrCode INTERFACE_FUNC | getVisible (Bool *visible)=0 |
Gets visible metadata state of the component. More... | |
| virtual ErrCode INTERFACE_FUNC | setVisible (Bool visible)=0 |
Sets visible attribute state of the component. More... | |
| virtual ErrCode INTERFACE_FUNC | getLockedAttributes (IList **attributes)=0 |
| Gets a list of the component's locked attributes. The locked attributes cannot be modified via their respective setters. More... | |
| virtual ErrCode INTERFACE_FUNC | getOnComponentCoreEvent (IEvent **event)=0 |
| Gets the Core Event object that triggers whenever a change to this component happens within the openDAQ core structure. More... | |
| virtual ErrCode INTERFACE_FUNC | getStatusContainer (IComponentStatusContainer **statusContainer)=0 |
| Gets the container of Component statuses. More... | |
| virtual ErrCode INTERFACE_FUNC | findComponent (IString *id, IComponent **outComponent)=0 |
| Finds the component (signal/device/function block) with the specified (global) id. More... | |
| Public Member Functions inherited from IPropertyObject | |
| virtual ErrCode INTERFACE_FUNC | getClassName (IString **className)=0 |
| Gets the name of the class the Property object was constructed with. More... | |
| virtual ErrCode INTERFACE_FUNC | setPropertyValue (IString *propertyName, IBaseObject *value)=0 |
| Sets the value of the Property with the given name. More... | |
| virtual ErrCode INTERFACE_FUNC | getPropertyValue (IString *propertyName, IBaseObject **value)=0 |
| Gets the value of the Property with the given name. More... | |
| virtual ErrCode INTERFACE_FUNC | getPropertySelectionValue (IString *propertyName, IBaseObject **value)=0 |
| Gets the selected value of the Property, if the Property is a Selection property. More... | |
| virtual ErrCode INTERFACE_FUNC | clearPropertyValue (IString *propertyName)=0 |
| Clears the Property value from the Property object. More... | |
| virtual ErrCode INTERFACE_FUNC | hasProperty (IString *propertyName, Bool *hasProperty)=0 |
Checks if the Property object contains a property named propertyName. More... | |
| virtual ErrCode INTERFACE_FUNC | getProperty (IString *propertyName, IProperty **property)=0 |
Gets the Property with the given propertyName. More... | |
| virtual ErrCode INTERFACE_FUNC | addProperty (IProperty *property)=0 |
| Adds the property to the Property object. More... | |
| virtual ErrCode INTERFACE_FUNC | removeProperty (IString *propertyName)=0 |
Removes the Property named propertyName from the Property object. More... | |
| virtual ErrCode INTERFACE_FUNC | getOnPropertyValueWrite (IString *propertyName, IEvent **event)=0 |
Gets the Event that is triggered whenever a Property value is written to the Property named propertyName. More... | |
| virtual ErrCode INTERFACE_FUNC | getOnPropertyValueRead (IString *propertyName, IEvent **event)=0 |
Gets the Event that is triggered whenever a Property value of a Property named propertyName is read. More... | |
| virtual ErrCode INTERFACE_FUNC | getVisibleProperties (IList **properties)=0 |
| Returns a list of visible properties contained in the Property object. More... | |
| virtual ErrCode INTERFACE_FUNC | getAllProperties (IList **properties)=0 |
| Returns a list of all properties contained in the Property object. More... | |
| virtual ErrCode INTERFACE_FUNC | setPropertyOrder (IList *orderedPropertyNames)=0 |
| Sets a custom order of properties as defined in the list of property names. More... | |
| virtual ErrCode INTERFACE_FUNC | beginUpdate ()=0 |
| Begins batch configuration of the object. More... | |
| virtual ErrCode INTERFACE_FUNC | endUpdate ()=0 |
| Ends batch configuration of the object. More... | |
| virtual ErrCode INTERFACE_FUNC | getUpdating (Bool *updating)=0 |
| Returns the state of batch configuration. More... | |
| virtual ErrCode INTERFACE_FUNC | getOnEndUpdate (IEvent **event)=0 |
| Gets the Event that is triggered whenever the batch configuration is applied. More... | |
| virtual ErrCode INTERFACE_FUNC | getPermissionManager (IPermissionManager **permissionManager)=0 |
| Gets the permission manager of property object. More... | |
| Public Member Functions inherited from IBaseObject | |
| virtual ErrCode INTERFACE_FUNC | borrowInterface (const IntfID &intfID, void **obj) const =0 |
| Returns another interface which is supported by the object without incrementing the reference count. More... | |
| virtual ErrCode INTERFACE_FUNC | dispose ()=0 |
| Disposes all references held by the object. More... | |
| virtual ErrCode INTERFACE_FUNC | getHashCode (SizeT *hashCode)=0 |
| Returns hash code of the object. More... | |
| virtual ErrCode INTERFACE_FUNC | equals (IBaseObject *other, Bool *equal) const =0 |
| Compares object to another object for equality. More... | |
| virtual ErrCode INTERFACE_FUNC | toString (CharPtr *str)=0 |
| Returns a string representation of the object. More... | |
| Public Member Functions inherited from IUnknown | |
| virtual ErrCode INTERFACE_FUNC | queryInterface (const IntfID &intfID, void **obj)=0 |
| Returns another interface which is supported by the object and increments the reference count. More... | |
| virtual int INTERFACE_FUNC | addRef ()=0 |
| Increments the reference count for an interface on an object. More... | |
| virtual int INTERFACE_FUNC | releaseRef ()=0 |
| Decrements the reference count for an interface on an object. More... | |
Gets the server id.
| [out] | serverId | The server id. |
|
pure virtual |
Gets a list of the server's signals.
| [out] | signals | The flat list of signals. |
Server signals are most often the mirrored representations of signals that belong to the client connected to the instance via this server.
1.8.17