NzaeFactory Interface reference

Used to create all objects and provide all information that is dependent on the underlying C implementation of AE.

Public member functions

NzaeRemoteProtocol createListener(NzaeConnectionPoint connectionPoint)
Creates a new listener for remote AE connections.
NzaeAgg getLocalAggregationApi(NzaeAggInitialization arg)
Creates and returns the local instance of Aggregation NzaeAgg.
NzaeApi getLocalApi()
Returns the local API determined by how the AE was launched.
Nzae getLocalFunctionApi(NzaeInitialization arg)
Creates and returns the local instance of Function Nzae .
NzaeShaper getLocalShaperApi(NzaeShaperInitialization arg)
Creates and returns the local instance of Shaper NzaeShaper .
int getParentProcessId()
Returns, the parent ID of this process, which is useful for debugging.
int getProcessId()
Returns the process ID, which is useful for debugging.
boolean isLocal()
Determines is the process is a local AE.
boolean isRemote()
Returns true if this is a remote AE process.
NzaeConnectionPoint newConnectionPoint()
Returns a new instance of a connection point.

Public member functions documentation

NzaeRemoteProtocol createListener(NzaeConnectionPoint connectionPoint)
Creates a new listener for remote AE connections.
Parameters

  • NzaeConnectionPoint connectionPoint

    The Connection Point.

Returns

NzaeRemoteProtocol

The Remote Protocol listener.

Since one listener per unique connection name may be created, an AE may have multiple listeners.

NzaeAgg getLocalAggregationApi(NzaeAggInitialization arg)
Creates and returns the local instance of Aggregation NzaeAgg.
Parameters

  • NzaeAggInitialization arg

    The Aggregate initialization argument.

Returns

NzaeAgg

The AE Aggregate object.

NzaeApi getLocalApi()
Returns the local API determined by how the AE was launched.
Returns

NzaeApi

The API object.

(UDF,UDTF = function, or UDA = Aggregation, or function shaper and sizer.) This method is only valid for local AEs.

Nzae getLocalFunctionApi(NzaeInitialization arg)
Creates and returns the local instance of Function Nzae .
Parameters

  • NzaeInitialization arg

    The function initialization argument.

Returns

Nzae

The AE function object.

NzaeShaper getLocalShaperApi(NzaeShaperInitialization arg)
Creates and returns the local instance of Shaper NzaeShaper .
Parameters

  • NzaeShaperInitialization arg

    The Shaper initialization argument.

Returns

NzaeShaper

The AE Shaper object.

int getParentProcessId()
Returns, the parent ID of this process, which is useful for debugging.
Returns

The Parent process ID.

int getProcessId()
Returns the process ID, which is useful for debugging.
Returns

The Process ID.

boolean isLocal()
Determines is the process is a local AE.
Returns

TRUE if this is a local AE Process.

boolean isRemote()
Returns true if this is a remote AE process.
Returns

True if this is a remote AE Process

NzaeConnectionPoint newConnectionPoint()
Returns a new instance of a connection point.
Returns

NzaeConnectionPoint

The Connection Point.