NzaeApiGenerator Class reference

This class helps manage local and remote connections.

Public member functions

void close(): Closes the API object if it is owned, has a connection point, and has a remote protocol.
NzaeApi getApi(int type): Gets API.
NzaeRemoteProtocolCallback getCallbackHandler(): Gets the Remote Protocol Callback.
boolean isLocal(): Return true if this is a local AE process.
boolean isRemote(): Determines if the process is a remote AE.
boolean ownsAPI(): Determines if the helper owns the API.
void setCallbackHandler(NzaeRemoteProtocolCallback handler): Sets the Remote Protocol Callback.
void setDataSliceId(int dataSliceId): Sets the Connection Point dataslice ID.
void setName(String name): Sets the Connection Point Name.
void setOwnsAPI(boolean owns): Specifies if the object should manage the API.
void setSessionId(int sessionId): Sets the Connection Point session ID.
void setTransactionId(long transactionId): Set the Connection transaction ID.

Public member function documentation

void close()

Closes the API object if it is owned, has a connection point, and has a remote protocol.

NzaeApi getApi(int type)

Gets API.

Parameters

type

The specified API type or ANY.

Returns

NzaeApi

API is NULL in parent; in fork mode if remote.

Exceptions

NzaeException

Returns an API in either local or remote modes. Returns one of the specified type, or throws an excep- tion. The API may be owned by the helper or the caller, depending on the setting for ownsAPI.

See also: ownsAPI

NzaeRemoteProtocolCallback getCallbackHandler()

Gets the Remote Protocol Callback.

Returns

NzaeRemoteProtocolCallback

The callback.

boolean isLocal()

Return true if this is a local AE process.

Returns

true if local AE

boolean isRemote()

Determines if the process is a remote AE.

Returns

true if the process is a remote AE.

boolean ownsAPI()

Determines if the helper owns the API.

Returns

true if the helper owns the API.

void setCallbackHandler(NzaeRemoteProtocolCallback handler)

Sets the Remote Protocol Callback.

Parameters

NzaeRemoteProtocolCallback handler

The remote protocol handler.

void setDataSliceId(int dataSliceId)

Sets the Connection Point dataslice ID.

Parameters

dataSliceId

The Connection Point dataslice ID.

Does not override the remote values from the launcher available in NzaeConnectionPoint .

void setName(String name)

Sets the Connection Point Name.

Parameters

name

The Connection Point name.

Does not override the remote values from the launcher available in NzaeConnectionPoint .

void setOwnsAPI(boolean owns)

Specifies if the object should manage the API.

Parameters

owns

TRUE if the helper owns the API.

If TRUE, closes the API when a new API is accepted or the helper is closed.

void setSessionId(int sessionId)

Sets the Connection Point session ID.

Parameters

sessionId

The Connection Point session ID.

Does not override the remote values from the launcher available in NzaeConnectionPoint .

void setTransactionId(long transactionId)

Set the Connection transaction ID.

Parameters

transactionId

The Connection Point transaction ID.

Does not override the remote values from the launcher available in NzaeConnectionPoint .