Appendix A: Symphony API Summary

This section summarizes the scope of the service API with regard to the SPE.


Symphony API

Symphony class

Availability on SPE

SoamException (void) throw ()

SoamException

Not available

virtual const char * what () const throw ()

SoamException

pass return value to SPE when starting SPE thread

virtual SOAM_HRESULT getHR () const throw ()

SoamException

pass return value to SPE when starting SPE thread

virtual int getErrorCode (void) const throw ()

SoamException

pass return value to SPE when starting SPE thread

virtual const char * getErrorType (void) const throw ()

SoamException

pass return value to SPE when starting SPE thread

SoamException * getEmbeddedException (void) const throw ()

SoamException

Not available

SoamException & operator= (const SoamException &rhs)

SoamException

Not available

SoamException * operator-> () const

SoamExceptionPtr

Not available

bool isNull () const

SoamExceptionPtr

pass return value to SPE when starting SPE thread

void setNull ()

SoamExceptionPtr

Not available

SoamExceptionPtr & operator= (SoamExceptionPtr rhs)

SoamExceptionPtr

Not available

SoamExceptionPtr & operator= (SoamException *rhs)

SoamExceptionPtr

Not available

bool operator== (const SoamExceptionPtr &rhs) const

SoamExceptionPtr

pass return value to SPE when starting SPE thread

bool operator== (const SoamException *rhs) const

SoamExceptionPtr

pass return value to SPE when starting SPE thread

bool operator!= (const SoamExceptionPtr &rhs) const

SoamExceptionPtr

pass return value to SPE when starting SPE thread

bool operator!= (const SoamException *rhs) const

SoamExceptionPtr

pass return value to SPE when starting SPE thread

operator SoamException * () const

SoamExceptionPtr

Not available

FailureException (void) throw ()

FailureException

Not available

FailureException (const char *errorDescription, int errorCode=0) throw ()

FailureException

Not available

FailureException & operator= (const FailureException &rhs)

FailureException

Not available

void applyCustomizedDebugAction (bool shouldApply)

FailureException

Not available

FailureException * operator-> () const

FailureExceptionPtr

Not available

FatalException (void) throw ()

FatalException

Not available

FatalException (const char *errorDescription, int errorCode=0) throw ()

FatalException

Not available

FatalException & operator= (const FatalException &rhs)

FatalException

Not available

void applyCustomizedDebugAction (bool shouldApply)

FatalException

Not available

FatalException * operator-> () const

FatalExceptionPtr

Not available

T * operator-> () const

SoamSmartPtr

Not available

bool isNull () const

SoamSmartPtr

pass return value to SPE when starting SPE thread

void setNull ()

SoamSmartPtr

Not available

SoamSmartPtr< T > & operator= (SoamSmartPtr< T > other)

SoamSmartPtr

Not available

SoamSmartPtr< T > & operator= (T *obj)

SoamSmartPtr

Not available

bool operator== (const SoamSmartPtr< T > &a) const

SoamSmartPtr

pass return value to SPE when starting SPE thread

bool operator!= (const SoamSmartPtr< T > &a) const

SoamSmartPtr

pass return value to SPE when starting SPE thread

virtual void onCreateService (ServiceContextPtr &serviceContext)

ServiceContainer

Not available

virtual void onDestroyService ()

ServiceContainer

Not available

virtual void onSessionEnter (SessionContextPtr &sessionContext)

ServiceContainer

Not available

virtual void onSessionLeave ()

ServiceContainer

Not available

virtual void onInvoke (TaskContextPtr &taskContext)=0

ServiceContainer

Not available

virtual void onServiceInterrupt (ServiceContextPtr &serviceContext)

ServiceContainer

Not available

void run (void *stack=0, size_t stackSize=0)

ServiceContainer

Not available

int run (int argc, char *argv[], void *stack=0, size_t stackSize=0)

ServiceContainer

Not available

const char * getServiceName () const throw (SoamException)

ServiceContext

pass return value to SPE when starting SPE thread

InterruptEvent getLastInterruptEvent (SoamULong &gracePeriod) const throw (SoamException)

ServiceContext

pass return value/OUT parameter value to SPE when starting SPE thread

void setControlCode (SoamInt code) throw (SoamException)

ServiceContext

Not available

const char * getApplicationName () const throw (SoamException)

ServiceContext

pass return value to SPE when starting SPE thread

const char * getConsumerId () const throw (SoamException)

ServiceContext

pass return value to SPE when starting SPE thread

const char * getDeployDirectory () const throw (SoamException)

ServiceContext

pass return value to SPE when starting SPE thread

const char * getLogDirectory () const throw (SoamException)

ServiceContext

pass return value to SPE when starting SPE thread

const char * getSessionId (void) const throw (SoamException)

SessionContext

pass return value to SPE when starting SPE thread

void getCommonData (Message &commonData) const throw (SoamException)

SessionContext

Not available

void populateCommonData (Message &commonData) const throw (SoamException)

SessionContext

Not available

void discardCommonData (void) throw (SoamException)

SessionContext

Not available

const char * getSessionId (void) const throw (SoamException)

TaskContext

pass return value to SPE when starting SPE thread

const char * getTaskId (void) const throw (SoamException)

TaskContext

pass return value to SPE when starting SPE thread

void getInputMessage (Message &inMsg) const throw (SoamException)

TaskContext

Not available

void populateTaskInput (Message &inputMessage) const throw (SoamException)

TaskContext

Not available

void setOutputMessage (Message &outMsg) throw (SoamException)

TaskContext

Not available

void setTaskOutput (Message &outputMessage) throw (SoamException)

TaskContext

Not available

void discardInputMessage (void) throw (SoamException)

TaskContext

Not available

TaskContextPtr

virtual void onSerialize (OutputStreamPtr &stream)=0 throw (SoamException)

Message

Not available

virtual void onDeserialize (InputStreamPtr &stream)=0 throw (SoamException)

Message

Not available

DefaultBinaryMessage (void)

DefaultBinaryMessage

Not available

DefaultBinaryMessage (const char *buffer, unsigned long length, bool shouldCopy=false)

DefaultBinaryMessage

Not available

void onSerialize (OutputStreamPtr &stream) throw (SoamException)

DefaultBinaryMessage

Not available

void onDeserialize (InputStreamPtr &stream) throw (SoamException)

DefaultBinaryMessage

Not available

void setBuffer (const char *buffer, unsigned long length, bool shouldCopy=false)

DefaultBinaryMessage

Not available

const char * getBuffer (unsigned long &length) const

DefaultBinaryMessage

pass return value/OUT parameter value to SPE when starting SPE thread

DefaultByteArrayMessage (void)

DefaultByteArrayMessage

Not available

DefaultByteArrayMessage (const void *byteArray, SoamUInt length, SoamBool shouldCopy=false)

DefaultByteArrayMessage

Not available

void onSerialize (OutputStreamPtr &stream) throw (SoamException)

DefaultByteArrayMessage

Not available

void onDeserialize (InputStreamPtr &stream) throw (SoamException)

DefaultByteArrayMessage

Not available

void setByteArray (const void *byteArray, SoamUInt length, SoamBool shouldCopy=false)

DefaultByteArrayMessage

Not available

void getByteArray (char *&byteArray, SoamUInt &length, SoamBool shouldCopy=false) const

DefaultByteArrayMessage

pass OUT parameter value to SPE when starting SPE thread

DefaultTextMessage (void)

DefaultTextMessage

Not available

DefaultTextMessage (const std::string &text)

DefaultTextMessage

Not available

DefaultTextMessage (const char *text)

DefaultTextMessage

Not available

void onSerialize (OutputStreamPtr &stream) throw (SoamException)

DefaultTextMessage

Not available

void onDeserialize (InputStreamPtr &stream) throw (SoamException)

DefaultTextMessage

Not available

void setText (const std::string &text)

DefaultTextMessage

Not available

void setText (const char *text)

DefaultTextMessage

Not available

void getText (std::string &text) const

DefaultTextMessage

pass OUT parameter value to SPE when starting SPE thread

const char * getText () const

DefaultTextMessage

pass return value to SPE when starting SPE thread

operator const char * () const

DefaultTextMessage

pass return value to SPE when starting SPE thread

bool getNext (TaskOutputHandlePtr &taskOutputHandle) throw (SoamException)

EnumItems

pass return value to SPE when starting SPE thread

void reset () throw (SoamException)

EnumItems

Not available

void skip (SoamULong skipCount) throw (SoamException)

EnumItems

Not available

SoamULong getCount () throw (SoamException)

EnumItems

pass return value to SPE when starting SPE thread

EnumItemsPtr clone () throw (SoamException)

EnumItems

Not available

virtual void read (short &x) throw (SoamException)

InputStream

pass OUT parameter value to SPE when starting SPE thread

virtual void read (unsigned short &x) throw (SoamException)

InputStream

pass OUT parameter value to SPE when starting SPE thread

virtual void read (int &x) throw (SoamException)

InputStream

pass OUT parameter value to SPE when starting SPE thread

virtual void read (unsigned int &x) throw (SoamException)

InputStream

pass OUT parameter value to SPE when starting SPE thread

virtual void read (long &x) throw (SoamException)

InputStream

pass OUT parameter value to SPE when starting SPE thread

virtual void read (unsigned long &x) throw (SoamException)

InputStream

pass OUT parameter value to SPE when starting SPE thread

virtual void read (long long &x) throw (SoamException)

InputStream

pass OUT parameter value to SPE when starting SPE thread

virtual void read (unsigned long long &x) throw (SoamException)

InputStream

pass OUT parameter value to SPE when starting SPE thread

virtual void read (float &x) throw (SoamException)

InputStream

pass OUT parameter value to SPE when starting SPE thread

virtual void read (double &x) throw (SoamException)

InputStream

pass OUT parameter value to SPE when starting SPE thread

virtual void read (bool &x) throw (SoamException)

InputStream

pass OUT parameter value to SPE when starting SPE thread

virtual void read (char &x) throw (SoamException)

InputStream

pass OUT parameter value to SPE when starting SPE thread

virtual void read (char *&x) throw (SoamException)

InputStream

pass OUT parameter value to SPE when starting SPE thread

virtual void read (std::string &x) throw (SoamException)

InputStream

pass OUT parameter value to SPE when starting SPE thread

virtual void readBytes (void *x, unsigned long length) throw (SoamException)

InputStream

pass OUT parameter value to SPE when starting SPE thread

virtual void readByteArray (char *&x, unsigned long &length) throw (SoamException)

InputStream

pass OUT parameter value to SPE when starting SPE thread

virtual void write (short x) throw (SoamException)

OutputStream

Not available

virtual void write (unsigned short x) throw (SoamException)

OutputStream

Not available

virtual void write (int x) throw (SoamException)

OutputStream

Not available

virtual void write (unsigned int x) throw (SoamException)

OutputStream

Not available

virtual void write (long x) throw (SoamException)

OutputStream

Not available

virtual void write (unsigned long x) throw (SoamException)

OutputStream

Not available

virtual void write (long long x) throw (SoamException)

OutputStream

Not available

virtual void write (unsigned long long x) throw (SoamException)

OutputStream

Not available

virtual void write (float x) throw (SoamException)

OutputStream

Not available

virtual void write (double x) throw (SoamException)

OutputStream

Not available

virtual void write (bool x) throw (SoamException)

OutputStream

Not available

virtual void write (char x) throw (SoamException)

OutputStream

Not available

virtual void write (const char *x) throw (SoamException)

OutputStream

Not available

virtual void write (const std::string &x) throw (SoamException)

OutputStream

Not available

virtual void writeBytes (const void *x, unsigned long length) throw (SoamException)

OutputStream

Not available

virtual void writeByteArray (const char *x, unsigned int offset, unsigned int length) throw (SoamException)

OutputStream

Not available