Classes | Static Public Member Functions | Protected Member Functions | Protected Attributes | Private Attributes | List of all members
uavcan::ServiceClientBase Class Reference

#include <service_client.hpp>

Inheritance diagram for uavcan::ServiceClientBase:
Inheritance graph
[legend]

Classes

class  CallState
 
struct  CallStateMatchingPredicate
 
struct  ServerSearchPredicate
 

Static Public Member Functions

static MonotonicDuration getDefaultRequestTimeout ()
 
static MonotonicDuration getMaxRequestTimeout ()
 
static MonotonicDuration getMinRequestTimeout ()
 

Protected Member Functions

int prepareToCall (INode &node, const char *dtname, NodeID server_node_id, ServiceCallID &out_call_id)
 
 ServiceClientBase (INode &node)
 
virtual ~ServiceClientBase ()
 
- Protected Member Functions inherited from uavcan::ITransferAcceptanceFilter
virtual bool shouldAcceptFrame (const RxFrame &frame) const =0
 
virtual ~ITransferAcceptanceFilter ()
 
- Protected Member Functions inherited from uavcan::DeadlineHandler
 DeadlineHandler (Scheduler &scheduler)
 
virtual ~DeadlineHandler ()
 
void generateDeadlineImmediately ()
 
MonotonicTime getDeadline () const
 
SchedulergetScheduler () const
 
virtual void handleDeadline (MonotonicTime current)=0
 
bool isRunning () const
 
void startWithDeadline (MonotonicTime deadline)
 
void startWithDelay (MonotonicDuration delay)
 
void stop ()
 
- Protected Member Functions inherited from uavcan::LinkedListNode< DeadlineHandler >
 LinkedListNode ()
 
 ~LinkedListNode ()
 
DeadlineHandlergetNextListNode () const
 
void setNextListNode (DeadlineHandler *node)
 

Protected Attributes

MonotonicDuration request_timeout_
 
- Protected Attributes inherited from uavcan::DeadlineHandler
Schedulerscheduler_
 

Private Attributes

const DataTypeDescriptordata_type_descriptor_
 This will be initialized at the time of first call. More...
 

Detailed Description

Do not use directly.

Definition at line 117 of file service_client.hpp.

Constructor & Destructor Documentation

◆ ServiceClientBase()

uavcan::ServiceClientBase::ServiceClientBase ( INode node)
inlineprotected

Definition at line 170 of file service_client.hpp.

◆ ~ServiceClientBase()

virtual uavcan::ServiceClientBase::~ServiceClientBase ( )
inlineprotectedvirtual

Definition at line 176 of file service_client.hpp.

Member Function Documentation

◆ getDefaultRequestTimeout()

static MonotonicDuration uavcan::ServiceClientBase::getDefaultRequestTimeout ( )
inlinestatic

It's not recommended to override default timeouts. Change of this value will not affect pending calls.

Definition at line 185 of file service_client.hpp.

◆ getMaxRequestTimeout()

static MonotonicDuration uavcan::ServiceClientBase::getMaxRequestTimeout ( )
inlinestatic

Definition at line 187 of file service_client.hpp.

◆ getMinRequestTimeout()

static MonotonicDuration uavcan::ServiceClientBase::getMinRequestTimeout ( )
inlinestatic

Definition at line 186 of file service_client.hpp.

◆ prepareToCall()

int uavcan::ServiceClientBase::prepareToCall ( INode node,
const char *  dtname,
NodeID  server_node_id,
ServiceCallID out_call_id 
)
protected

Definition at line 31 of file uc_service_client.cpp.

Member Data Documentation

◆ data_type_descriptor_

const DataTypeDescriptor* uavcan::ServiceClientBase::data_type_descriptor_
private

This will be initialized at the time of first call.

Definition at line 120 of file service_client.hpp.

◆ request_timeout_

MonotonicDuration uavcan::ServiceClientBase::request_timeout_
protected

Definition at line 168 of file service_client.hpp.


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


uavcan_communicator
Author(s):
autogenerated on Fri Dec 13 2024 03:10:05