Remote AE functions

Function/Subroutine documentation

• subroutine nzaeDisableForking()

  Disables forking in the remote AE.

  Forking is enabled by default in remote AEs. This routine disables it.

• subroutine nzaeEnableForking()

  Enables forking in the remote AE.

  Forking is enabled by default in remote AEs. If it was previously disabled, this function re-enables forking for the AE.

• subroutine nzaeGetConnectionPointName(name)

  Gets the remote AE connection point name.

  • Parameters
    • name

      (character*) The remote connection point name.

• subroutine nzaeGetConnectionPointDatasliceId(id)

  Gets the connection point dataslice ID.

  • Parameters
    • id

      (integer) The remote dataslice ID.

  This routine is generally not needed if using the standard remote launch mechanism since the AE gets the ID from the environment set up by the remote launch mechanism.

• subroutine nzaeGetConnectionPointSessionId(id)

  Gets the connection point session ID.

  • Parameters
    • id

      (integer) The remote session ID.

  This routine is generally not needed if using the standard remote launch mechanism as the AE gets the ID from the environment set up by the remote launch mechanism.

• subroutine nzaeGetConnectionPointTransactionId(idString)

  Gets the connection point transaction ID.

  • Parameters
    • idString

      (character*) A string representing the numeric connection point transaction ID. The string must be at least 21 characters long or else the result string is filled with the NULL character ('').

• subroutine nzaeIsForkingEnabled(isEnabled)

  Determines if forking is enabled in the remote AE.

  • Parameters
    • isEnabled

      (integer) The value is 1 if forking is enabled, which is the default; 0 if not enabled.

• subroutine nzaeIsRemoteProtocolCodeControlData(code, result)

  Determines if a remote protocol code is a CONTROL_DATA code.

  • Parameters
    • code

      (integer) The remote protocol code passed in to the remote protocol callback.

    • result

      (integer) The value is 1 if the code is a CONTROL_DATA code; 0 otherwise.

• subroutine nzaeIsRemoteProtocolCodePing(code, result)

  Determines if a remote protocol code is a PING code.

  • Parameters
    • code

      (integer) The remote protocol code passed in to the remote protocol callback.

    • result

      (integer) The value is 1 if the code is a PING code; 0 otherwise.

• subroutine nzaeIsRemoteProtocolCodeRequest(code, result)

  Determines if a remote protocol code is a REQUEST code.

  • Parameters
    • code

      (integer) The remote protocol code passed in to the remote protocol callback.

    • result

      (integer) The value is 1 if the code is a REQUEST code; 0 otherwise.

• subroutine nzaeIsRemoteProtocolCodeStatus(code, result)

  Determines if a remote protocol code is a STATUS code.

  • Parameters
    • code

      (integer) The remote protocol code passed in to the remote protocol callback.

    • result

      (integer) The value is 1 if the code is a STATUS code; 0 otherwise.

• subroutine nzaeIsRemoteProtocolCodeStop(code, result)

  Determines if a remote protocol code is a STOP code.

  • Parameters
    • code

      (integer) The remote protocol code passed in to the remote protocol callback.

    • result

      (integer) The value is 1 if the code is a STOP code; 0 otherwise.

• subroutine nzaeSetConnectionPointName(name)

  Sets the remote AE connection point name.

  • Parameters
    • name

      (character*) The remote connection point name.

• subroutine nzaeSetConnectionPointDatasliceId(id)

  Sets the remote dataslice ID.

  • Parameters
    • id

      (integer) The remote dataslice ID.

  This routine is generally not needed if using the standard remote launch mechanism since the AE gets the ID from the environment set up by the remote launch mechanism.

• subroutine nzaeSetConnectionPointSessionId(id)

  Sets the remote session ID.

  • Parameters
    • id

      (integer) The remote session ID.

  This routine is generally not needed if using the standard remote launch mechanism since the AE gets the ID from the environment set up by the remote launch mechanism.

• subroutine nzaeSetConnectionPointTransactionId(idString, result)

  Sets the connection point transaction ID.

  • Parameters
    • idString

      (character*) A string representing the numeric remote transaction ID.

    • result

      (integer) The result is 1 if the function succeeded; 0 otherwise.

  This routine is generally not needed if using the standard remote launch mechanism since the AE gets the ID from the environment set up by the remote launch mechanism. A string is required because the Fortran 77 specification does not handle 64 bit integers.

• subroutine nzaeSetRemoteProtocolCallback(callback)

  Sets the subroutine that will be called for handling remote protocol messages.

  • Parameters
    • callback

      (subroutine(integer, character*)) The subroutine to be called.

  The subroutine that is passed in receives an integer code that can be identified with the nzaeIsRemoteProtocolCodeXXX() functions. The string that is passed in may contain data from the AE subsystem. Both parameters are also used as output to the AE subsystem. The length of the string that is passed in must be at least 1000 bytes.