#include <UdsOp.h>

Inheritance diagram for Ipc::UdsOp:
Collaboration diagram for Ipc::UdsOp:

Public Types

typedef CbcPointer< AsyncJobPointer
 

Public Member Functions

 UdsOp (const String &pathAddr)
 
virtual ~UdsOp ()
 
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 timedout ()
 called after setTimeout() if timed out More...
 
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 void start ()
 called by AsyncStart; do not call directly More...
 
virtual bool doneAll () const
 whether positive goal has been reached More...
 
virtual void swanSong ()
 
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

void noteTimeout (const CommTimeoutCbParams &p)
 Comm timeout callback; calls timedout() More...
 
 UdsOp (const UdsOp &)
 
UdsOpoperator= (const UdsOp &)
 

Private Attributes

int options
 UDS options. More...
 
Comm::ConnectionPointer conn_
 UDS descriptor. More...
 

Detailed Description

code shared by unix-domain socket senders (e.g., UdsSender or Coordinator) and receivers (e.g. Port or Coordinator)

Definition at line 29 of file UdsOp.h.

Member Typedef Documentation

Definition at line 34 of file AsyncJob.h.

Constructor & Destructor Documentation

Ipc::UdsOp::UdsOp ( const String pathAddr)

Definition at line 19 of file UdsOp.cc.

References debugs, and HERE().

Ipc::UdsOp::~UdsOp ( )
virtual

Definition at line 27 of file UdsOp.cc.

References debugs, HERE(), Comm::IsConnOpen(), and NULL.

Ipc::UdsOp::UdsOp ( const UdsOp )
private

Member Function Documentation

void AsyncJob::callEnd ( )
virtualinherited
void AsyncJob::callStart ( AsyncCall call)
inherited
bool AsyncJob::canBeCalled ( AsyncCall call) const
inherited

Definition at line 101 of file AsyncJob.cc.

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

void Ipc::UdsOp::clearTimeout ( )
protected

Definition at line 62 of file UdsOp.cc.

References commUnsetConnTimeout(), and conn.

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

Definition at line 41 of file UdsOp.cc.

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

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

Definition at line 90 of file AsyncJob.cc.

References AsyncJob::doneAll(), NULL, and AsyncJob::stopReason.

Referenced by AsyncJob::callEnd(), and Downloader::downloadFinished().

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

Definition at line 67 of file UdsOp.cc.

Referenced by setTimeout().

UdsOp& Ipc::UdsOp::operator= ( const UdsOp )
private
void Ipc::UdsOp::setOptions ( int  newOptions)
protected

Definition at line 35 of file UdsOp.cc.

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

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

Definition at line 54 of file UdsOp.cc.

References asyncCall(), commSetConnTimeout(), conn, handler(), and noteTimeout().

virtual void Ipc::UdsOp::timedout ( )
inlineprotectedvirtual

Reimplemented in Ipc::UdsSender, and Ipc::Strand.

Definition at line 39 of file UdsOp.h.

virtual void* CbdataParent::toCbdata ( )
pure virtualinherited

Member Data Documentation

struct sockaddr_un Ipc::UdsOp::address

Definition at line 36 of file UdsOp.h.

Referenced by Ipc::UdsSender::UdsSender().

Comm::ConnectionPointer Ipc::UdsOp::conn_
private

Definition at line 55 of file UdsOp.h.

const InstanceId<AsyncJob> AsyncJob::id
protectedinherited

Definition at line 70 of file AsyncJob.h.

AsyncCall::Pointer AsyncJob::inCall
protectedinherited
int Ipc::UdsOp::options
private

Definition at line 54 of file UdsOp.h.

const char* AsyncJob::stopReason
protectedinherited

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

 

Introduction

Documentation

Support

Miscellaneous

Web Site Translations

Mirrors