ADTF
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Protected Member Functions | List of all members
adtf::streaming::IStreamingService Class Referenceabstract

#include <streaming_source_intf.h>

Inherits adtf::streaming::ant::INamedGraphObject.

Inherited by adtf::streaming::ant::IStreamingSink, and adtf::streaming::ant::IStreamingSource.

Public Types

enum  tStreamingState : uint8_t { State_Shutdown = 0 , State_Constructed = 1 , State_Initialized = 2 , State_Streaming = 3 }
 

Public Member Functions

 ADTF_IID (IStreamingService, "streaming_service.ant.streaming.adtf.iid")
 definiton of interface id
 
virtual tResult SetState (tStreamingState eState)=0
 
virtual tStreamingState GetState ()=0
 
- Public Member Functions inherited from adtf::streaming::ant::INamedGraphObject
 ADTF_IID (INamedGraphObject, "namedgraphobject.ant.streaming.adtf.iid")
 defintion of interface id
 
virtual tResult GetName (base::ant::IString &&strName) const =0
 
virtual tResult SetName (const char *strName)=0
 
virtual tResult SetParent (const ucom::ant::IObject *oParentObject)=0
 
virtual tResult GetParent (const ucom::ant::IObject *&poParentObject) const =0
 
- Public Member Functions inherited from adtf::ucom::ant::IObject
 ADTF_IID (IObject, "object.ant.ucom.adtf.iid")
 

Protected Member Functions

 ~IStreamingService ()=default
 protect DTOR
 
- Protected Member Functions inherited from adtf::streaming::ant::INamedGraphObject
 ~INamedGraphObject ()=default
 not destructable
 
- Protected Member Functions inherited from adtf::ucom::ant::IObject
 ~IObject ()=default
 Protected destructor --> Only the final implementation can be destroyed!
 

Detailed Description

Basic sec_streaming_service interface to set the state of an IStreamingService.

See also
streaming service.

Member Enumeration Documentation

◆ tStreamingState

enum adtf::streaming::ant::IStreamingService::tStreamingState : uint8_t

States of the Streaming Services.

See also
streaming service_state_machine
Enumerator
State_Shutdown 

first entry state.

State_Constructed 

All properties if the streaming service itself are set all pins can be created after this state the pins will be requested and connected

State_Initialized 

All Pins are requested, connected and their properties have been set.

State_Streaming 

Streaming Data begins, threads and timers should only start here!

Member Function Documentation

◆ GetState()

virtual tStreamingState adtf::streaming::ant::IStreamingService::GetState ( )
pure virtual

Gets the current state of the Streaming Service.

Returns
The current reached state. (only returns the right state if transition is completed).

◆ SetState()

virtual tResult adtf::streaming::ant::IStreamingService::SetState ( tStreamingState eState)
pure virtual

Sets the state of the Streaming Service.

Parameters
eState[in] State to set
Returns
Standard Result Code depends on the implementation of the Streaming Service
Remarks
Usually NOT thread-safe, should not be called from more than one thread!
The documentation for this class was generated from the following file: