- NzaeApi& getApi(nz::ae::NzaeApi::ApiType type)
- Gets an API object.
- Parameters
- ApiType type
- Specified API type or ANY.
- Returns
- NzaeApi
- The API object.
- Exceptions
- NzaeException
-
Returns an API object in either local or remote modes. Returns one of the specified type, or
throws an exception. The API is owned by the helper object.
The API object is the main object for an AE program.
- NzaeApi* getApi(nz::ae::NzaeApi::ApiType type, bool fork)
- Gets an API object.
- Parameters
- ApiType type
- Specified API type or ANY.
- fork
- Forks new process to handle if TRUE.
- Returns
- NzaeApi
- API object is NULL in parent if fork is TRUE and the AE is a remote AE.
- Exceptions
- NzaeException
-
Returns an API in either local or remote modes. Returns one of the specified types or throws an
excep- tion. The API may be owned by the helper or the caller, depending on the setting for ownsAPI
.
The API object is the main object for an AE program.
- NzaeRemoteProtocolCallback* getCallbackHandler()
- Gets the remote protocol callback handler.
- Parameters
- NzaeRemoteProtocolCallback
- The callback handler.
A remote protocol handler class is used to handle remote commands such as stop, status, and
ping.
- bool isLocal()
- Return true if this is a local AE process.
- Returns
- True if the AE is local
- bool isRemote()
- Return true if this is a remote AE process.
- Returns
- True if the AE is remote.
- NzaeApiGenerator()
- Constructor
- bool ownsAPI()
- Returns TRUE if the helper owns the API.
- Returns
- TRUE if the helper owns the API.
If TRUE, the API is deleted when a new one is accepted or the helper is deleted.
- void setCallbackHandler(NzaeRemoteProtocolCallback *handler)
- Sets the remote protocol callback handler.
- Parameters
- NzaeRemoteProtocolCallback handler
- The remote protocol handler.
A remote protocol handler class is used to handle remote commands such as stop, status and
ping.
- virtual void setDataSliceId(int dataSliceId)
- Sets the remote connection point dataslice ID.
- Parameters
- dataSliceId
- The dataslice ID of the remote connection point.
This function does not override the remote values from the launcher available in NzaeConnec-
tionPoint class.
- virtual void setName(const char *name)
- Sets the remote connection point name.
- Parameters
- name
- The remote connection point name.
This function does not override the remote values from the launcher available in the
NzaeConnection- Point class.
- void setOwnsAPI(bool owns)
- Sets whether this object should manage API.
- Parameters
- owns
- TRUE if the helper owns the API.
If TRUE, the API is deleted when a new one is accepted or the helper is deleted.
- virtual void setSessionId(int sessionId)
- Sets the remote connection point session ID.
- Parameters
- sessionId
- The remote connection point session ID.
This function does not override the remote values from the launcher available in
NzaeConnectionPoint class.
- virtual void setTransactionId(int64_t transactionId)
- Sets the remote connection transaction ID.
- Parameters
- transactionId
- The remote connection point transaction ID.
This function does not override the remote values from the launcher available in
NzaeConnectionPoint class.
- ~NzaeApiGenerator()
- Destructor.
- Deletes the API object if it is owned. Deletes the connection point and remote protocol objects.