GATE
gate_startable_t Interface Reference

Interface to start and stop a background operation and to receive its status. More...

#include <objects.h>

Inheritance diagram for gate_startable_t:
gate_object_t gate_msgqueue_t

Public Member Functions

gate_result_t start ()
 Starts an operation.
 
gate_result_t stop ()
 Stops a running operation.
 
gate_enumint_t get_status ()
 Retrieves a status indicator about the started or stopped operation.
 
- Public Member Functions inherited from gate_object_t
char const * get_interface_name ()
 Returns on object's interface path name.
 
void release ()
 Decrease object's reference counter, releases the object when count reaches zero.
 
int retain ()
 Increase object's reference counter.
 

Detailed Description

Interface to start and stop a background operation and to receive its status.

Member Function Documentation

◆ get_status()

gate_enumint_t get_status ( )

Retrieves a status indicator about the started or stopped operation.

Implemented in gate_msgqueue_t.

◆ start()

gate_result_t start ( )

Starts an operation.

Implemented in gate_msgqueue_t.

◆ stop()

gate_result_t stop ( )

Stops a running operation.

Implemented in gate_msgqueue_t.


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