Remote Connection Point

A Remote Connection Point is how the Netezza system addresses a Remote AE.

Functions

  • const char* nzaeconptBuildFileTypeName(NZAECONPT_HANDLE handle) Builds and returns the file type connection point fully qualified name for file format connection proto-cols, such as Unix Sockets.
  • void nzaeconptClose(NZAECONPT_HANDLE handle) Closes the connection point.
  • NZAECONPT_HANDLE nzaeconptCreate() Creates and returns a new NZAECONPT_HANDLE handle.
  • int32_t nzaeconptGetDataSliceId(const NZAECONPT_HANDLE handle) Gets the data slice ID for a connection point.
  • const char* nzaeconptGetName(const NZAECONPT_HANDLE handle) Returns the connection point name.
  • int32_t nzaeconptGetSessionId(const NZAECONPT_HANDLE handle) Gets the session ID for a connection point.
  • int64_t nzaeconptGetTransactionId(const NZAECONPT_HANDLE handle) Gets the transaction ID setting for a connection point.
  • NzaeConptType nzaeconptGetType(const NZAECONPT_HANDLE handle) Get the connection point type.
  • void nzaeconptSetDataSliceId(NZAECONPT_HANDLE handle, int32_t dataSliceId) Optionally sets the dataslice ID.
  • int nzaeconptSetName(NZAECONPT_HANDLE handle, const char *name) Optionally sets the connection point name. Returns 0 on success, -1 on error.
  • void nzaeconptSetSessionId(NZAECONPT_HANDLE handle, int32_t sessionId) Optionally sets the session ID.
  • void nzaeconptSetTransactionId(NZAECONPT_HANDLE handle, int64_t transactionId) Optionally sets the transaction ID.
  • void nzaeconptSetType(NZAECONPT_HANDLE handle, NzaeConptType conptType) Optional Function: manually set the connection point type. Usually the connection point uses a default type based on the AE Environment variables of the AE process such as NZAE_REMOTE.

Enumerations

enum NzaeConptType { NZAE_CONPT_UNKNOWN= 0, NZAE_CONPT_REMOTE, NZAE_CONPT_EXTERNAL }

Connection point types.

Detailed description

A Remote Connection Point is how the Netezza system addresses a Remote AE.

Function documentation

const char* nzaeconptBuildFileTypeName(NZAECONPT_HANDLE handle)
Builds and returns the file type connection point fully qualified name for file format connec-tion protocols, such as Unix Sockets.
Parameters:
  • handle

    The connection point handle.

    Returns: The connection point file name; NULL on error.

    Returns NULL on error. The name format is based on name, tranaction ID, session ID and data slice ID,of which one or more must be specified. This function is used internally but may also be used for logging or diagnostic purposes. The qualified name format is subject to change between releases.

void nzaeconptClose(NZAECONPT_HANDLE handle)
Closes the connection point.
Parameters:
  • handle

    The connection point handle.

NZAECONPT_HANDLE nzaeconptCreate()
Gets the data slice ID for a connection point.
Parameters:
  • handle

    The connection point handle.

    Returns: The connection point dataslice ID.

const char* nzaeconptGetName(const NZAECONPT_HANDLE handle)
Returns the connection point name.
Parameters:
  • handle

    The connection point handle.

    Returns: The connection point name.

int32_t nzaeconptGetSessionId(const NZAECONPT_HANDLE handle)
Gets the session ID for a connection point.
Parameters:
  • handle

    The connection point handle.

    Returns: The connection point session ID.

int64_t nzaeconptGetTransactionId(const NZAECONPT_HANDLE handle)
Gets the transaction ID setting for a connection point.
Parameters:
  • handle

    The connection point handle.

    Returns: The connection point transaction ID.

NzaeConptType nzaeconptGetType(const NZAECONPT_HANDLE handle)
Get the connection point type.
Parameters:
  • handle

    The connection point handle.

    Returns NzaeConptType - the connection point transaction ID.

void nzaeconptSetDataSliceId(NZAECONPT_HANDLE handle, int32_t dataSliceId)
Optionally sets the dataslice ID.
Parameters:
  • handle

    The connection point handle.

  • dataSliceId

    The data slice ID.

int nzaeconptSetName(NZAECONPT_HANDLE handle, const char *name)
Optionally sets the connection point name. Returns 0 on success, -1 on error
Parameters:
  • handle

    The connection point handle.

  • name

    The connection point name.

Returns: A value of 0 on success, -1 on error.
void nzaeconptSetSessionId(NZAECONPT_HANDLE handle, int32_t sessionId)
Optionally sets the session ID.
Parameters:
  • handle

    The connection point handle.

  • sessionId

    The session ID.

void nzaeconptSetTransactionId(NZAECONPT_HANDLE handle, int64_t transactionId)
Optionally sets the transaction ID.
Parameters:
  • handle

    The connection point handle.

  • transactionId

    The transaction ID.

void nzaeconptSetType(NZAECONPT_HANDLE handle, NzaeConptType conptType)
Optional Function: manually set the connection point type. Usually the connection point uses a default type based on the AE Environment variables of the AE process such as NZAE_RE-MOTE.
Parameters:
  • handle

    The connection point handle.

  • NzaeConptType conptType

    The connection point type as defined in NzaeConptType.

Enumeration type documentation

enum NzaeConptType

Connection point types.

NZAE_CONPT_UNKNOWN NZAE_CONPT_REMOTE NZAE_CONPT_EXTERNAL

External AE is not supported