'Classic' CCA c++ binding (ccaffeine-only) 0.5.7
Public Member Functions | List of all members
classic::gov::cca::GoPort Class Reference

UNADOPTED Standard: A just-do-it port. More...

#include <GoPort.h>

Inheritance diagram for classic::gov::cca::GoPort:
Inheritance graph
[legend]
Collaboration diagram for classic::gov::cca::GoPort:
Collaboration graph
[legend]

Public Member Functions

virtual ~GoPort ()
 obligatory vdtor
 
virtual int go () CLASSIC_CCA_PURE
 Make the component do its thing.
 
- Public Member Functions inherited from classic::gov::cca::Port
virtual ~Port ()
 obligatory virtual destructor
 

Detailed Description

UNADOPTED Standard: A just-do-it port.

Tremendously useful. The canonical string type-name for this port is "GoPort", though it should probably be "gov.cca.GoPort".

Constructor & Destructor Documentation

◆ ~GoPort()

virtual classic::gov::cca::GoPort::~GoPort ( )
inlinevirtual

obligatory vdtor

18{}

Member Function Documentation

◆ go()

virtual int classic::gov::cca::GoPort::go ( )
virtual

Make the component do its thing.

The component does not throw c++ exceptions except in the form of returning -2.

Returns
  • 0 if did ok
  • -1 if had problem,
  • -2 if had problem bad enough to shoot the component in the head or exit the framework.

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