attempts to send an IPC message a few times, with a timeout More...

#include <UdsOp.h>

Inheritance diagram for Ipc::UdsSender:
Collaboration diagram for Ipc::UdsSender:

Public Types

typedef CbcPointer< AsyncJobPointer
 

Public Member Functions

 UdsSender (const String &pathAddr, const TypedMsgHdr &aMessage)
 
bool canBeCalled (AsyncCall &call) const
 whether we can be called More...
 
void callStart (AsyncCall &call)
 
virtual void callEnd ()
 called right after the called job method More...
 
virtual void callException (const std::exception &e)
 called when the job throws during an async call More...
 
virtual void * toCbdata ()=0
 

Static Public Member Functions

static Pointer Start (AsyncJob *job)
 starts a freshly created job (i.e., makes the job asynchronous) More...
 

Public Attributes

struct sockaddr_un address
 UDS address from path; treat as read-only. More...
 

Protected Member Functions

virtual void swanSong ()
 
virtual void start ()
 called by AsyncStart; do not call directly More...
 
virtual bool doneAll () const
 whether positive goal has been reached More...
 
virtual void timedout ()
 
Comm::ConnectionPointerconn ()
 creates if needed and returns raw UDS socket descriptor More...
 
void setTimeout (int seconds, const char *handlerName)
 call timedout() if no UDS messages in a given number of seconds More...
 
void clearTimeout ()
 remove previously set timeout, if any More...
 
void setOptions (int newOptions)
 changes socket options More...
 
void deleteThis (const char *aReason)
 
void mustStop (const char *aReason)
 
bool done () const
 the job is destroyed in callEnd() when done() More...
 
virtual const char * status () const
 internal cleanup; do not call directly More...
 

Protected Attributes

const char * stopReason
 reason for forcing done() to be true More...
 
const char * typeName
 kid (leaf) class name, for debugging More...
 
AsyncCall::Pointer inCall
 the asynchronous call being handled, if any More...
 
const InstanceId< AsyncJobid
 job identifier More...
 

Private Member Functions

 CBDATA_CLASS (UdsSender)
 
void startSleep ()
 pause for a while before resending the message More...
 
void cancelSleep ()
 stop sleeping (or do nothing if we were not) More...
 
void delayedRetry ()
 make another sending attempt after a pause More...
 
void write ()
 schedule writing More...
 
void wrote (const CommIoCbParams &params)
 done writing or error More...
 
 UdsSender (const UdsSender &)
 
UdsSenderoperator= (const UdsSender &)
 
void noteTimeout (const CommTimeoutCbParams &p)
 Comm timeout callback; calls timedout() More...
 

Static Private Member Functions

static void DelayedRetry (void *data)
 legacy wrapper for Ipc::UdsSender::delayedRetry() More...
 

Private Attributes

TypedMsgHdr message
 what to send More...
 
int retries
 how many times to try after a write error More...
 
int timeout
 total time to send the message More...
 
bool sleeping
 whether we are waiting to retry a failed write More...
 
bool writing
 whether Comm started and did not finish writing More...
 
int options
 UDS options. More...
 
Comm::ConnectionPointer conn_
 UDS descriptor. More...
 

Detailed Description

Definition at line 67 of file UdsOp.h.

Member Typedef Documentation

◆ Pointer

Definition at line 34 of file AsyncJob.h.

Constructor & Destructor Documentation

◆ UdsSender() [1/2]

Ipc::UdsSender::UdsSender ( const String pathAddr,
const TypedMsgHdr aMessage 
)

Definition at line 84 of file UdsOp.cc.

References Ipc::UdsOp::address, Ipc::TypedMsgHdr::address(), and message.

◆ UdsSender() [2/2]

Ipc::UdsSender::UdsSender ( const UdsSender )
private

Member Function Documentation

◆ callEnd()

void AsyncJob::callEnd ( )
virtualinherited

◆ callException()

◆ callStart()

void AsyncJob::callStart ( AsyncCall call)
inherited

◆ canBeCalled()

bool AsyncJob::canBeCalled ( AsyncCall call) const
inherited

Definition at line 101 of file AsyncJob.cc.

References AsyncCall::cancel(), debugs, HERE(), AsyncJob::inCall, and NULL.

◆ cancelSleep()

void Ipc::UdsSender::cancelSleep ( )
private

Definition at line 149 of file UdsOp.cc.

References debugs.

◆ CBDATA_CLASS()

Ipc::UdsSender::CBDATA_CLASS ( UdsSender  )
private

◆ clearTimeout()

void Ipc::UdsOp::clearTimeout ( )
protectedinherited

Definition at line 62 of file UdsOp.cc.

References commUnsetConnTimeout(), and conn.

◆ conn()

Comm::ConnectionPointer & Ipc::UdsOp::conn ( )
protectedinherited

Definition at line 41 of file UdsOp.cc.

References COMM_DOBIND, comm_open_uds(), Comm::Connection::fd, Comm::IsConnOpen(), Must, and NULL.

◆ delayedRetry()

void Ipc::UdsSender::delayedRetry ( )
private

Definition at line 173 of file UdsOp.cc.

References debugs, and HERE().

Referenced by DelayedRetry().

◆ DelayedRetry()

void Ipc::UdsSender::DelayedRetry ( void *  data)
staticprivate

Definition at line 159 of file UdsOp.cc.

References assert, data, delayedRetry(), JobCallback, and ScheduleCallHere.

Referenced by startSleep().

◆ deleteThis()

void AsyncJob::deleteThis ( const char *  aReason)
protectedinherited

◆ done()

bool AsyncJob::done ( ) const
protectedinherited

◆ doneAll()

bool Ipc::UdsSender::doneAll ( ) const
protectedvirtual

Reimplemented from AsyncJob.

Definition at line 112 of file UdsOp.cc.

References AsyncJob::doneAll().

◆ mustStop()

◆ noteTimeout()

void Ipc::UdsOp::noteTimeout ( const CommTimeoutCbParams p)
privateinherited

Definition at line 67 of file UdsOp.cc.

Referenced by Ipc::UdsOp::setTimeout().

◆ operator=()

UdsSender& Ipc::UdsSender::operator= ( const UdsSender )
private

◆ setOptions()

void Ipc::UdsOp::setOptions ( int  newOptions)
protectedinherited

Definition at line 35 of file UdsOp.cc.

Referenced by Ipc::Port::Port().

◆ setTimeout()

void Ipc::UdsOp::setTimeout ( int  seconds,
const char *  handlerName 
)
protectedinherited

Definition at line 54 of file UdsOp.cc.

References asyncCall(), commSetConnTimeout(), conn, handler, and Ipc::UdsOp::noteTimeout().

◆ start()

void Ipc::UdsSender::start ( )
protectedvirtual

Reimplemented from AsyncJob.

Definition at line 104 of file UdsOp.cc.

References AsyncJob::start().

◆ Start()

◆ startSleep()

void Ipc::UdsSender::startSleep ( )
private

Definition at line 139 of file UdsOp.cc.

References DelayedRetry(), eventAdd(), and Must.

◆ status()

const char * AsyncJob::status ( ) const
protectedvirtualinherited

◆ swanSong()

void Ipc::UdsSender::swanSong ( )
protectedvirtual

Reimplemented from AsyncJob.

Definition at line 95 of file UdsOp.cc.

References AsyncJob::swanSong().

◆ timedout()

void Ipc::UdsSender::timedout ( )
protectedvirtual

Definition at line 182 of file UdsOp.cc.

References debugs, and HERE().

◆ toCbdata()

virtual void* CbdataParent::toCbdata ( )
pure virtualinherited

◆ write()

void Ipc::UdsSender::write ( )
private

Definition at line 117 of file UdsOp.cc.

References conn, debugs, HERE(), JobCallback, NULL, Comm::Write(), and wrote().

◆ wrote()

void Ipc::UdsSender::wrote ( const CommIoCbParams params)
private

Definition at line 127 of file UdsOp.cc.

References conn, CommCommonCbParams::conn, debugs, CommCommonCbParams::flag, HERE(), Comm::OK, and retries.

Referenced by write().

Member Data Documentation

◆ address

struct sockaddr_un Ipc::UdsOp::address
inherited

Definition at line 36 of file UdsOp.h.

Referenced by UdsSender().

◆ conn_

Comm::ConnectionPointer Ipc::UdsOp::conn_
privateinherited

Definition at line 55 of file UdsOp.h.

◆ id

const InstanceId<AsyncJob> AsyncJob::id
protectedinherited

Definition at line 72 of file AsyncJob.h.

◆ inCall

AsyncCall::Pointer AsyncJob::inCall
protectedinherited

◆ message

TypedMsgHdr Ipc::UdsSender::message
private

Definition at line 90 of file UdsOp.h.

Referenced by UdsSender().

◆ options

int Ipc::UdsOp::options
privateinherited

Definition at line 54 of file UdsOp.h.

◆ retries

int Ipc::UdsSender::retries
private

Definition at line 91 of file UdsOp.h.

◆ sleeping

bool Ipc::UdsSender::sleeping
private

Definition at line 93 of file UdsOp.h.

◆ stopReason

const char* AsyncJob::stopReason
protectedinherited

◆ timeout

int Ipc::UdsSender::timeout
private

Definition at line 92 of file UdsOp.h.

◆ typeName

◆ writing

bool Ipc::UdsSender::writing
private

Definition at line 94 of file UdsOp.h.


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

 

Introduction

Documentation

Support

Miscellaneous

Web Site Translations

Mirrors