ANNO_getRequestInfo

- return information about an annotation request

SYNOPSIS

#include <$OV_HEADER/ecs/ANNO/ANNO.h>

int32 ANNO_getRequestInfo (
const ANNO_ConnectionId annoId,
const ANNO_RequestId requestId,
char **circuitName,
char **annotateNodeName,
int32 *seqNum,
int32 *expiryTime );

DESCRIPTION

This function returns information about the source of the specified annotation request. The following information is returned:

• The name of the circuit that originated the request (circuitName). This function allocates space for this string which should be freed usingfree(3C) when it is no longer needed.
• The name of the annotate node that originated the request (annotateNodeName). The space allocated by ANNO_getRequestInfo for the string needs to be freed using free(3C) when it is no longer needed.
• The sequence number of the request within the originating Annotate node (seqNum).
• The time when an annotation response is required by the correlation engine (expiryTime).

Parameters

const ANNO_ConnectionId annoId

The annotation connection ID on which the annotation request was received.

const ANNO_RequestId requestId

The request ID of the annotation request.

char **circuitName

The address of a pointer to a string that will contain the name of the correlation circuit that issued the annotation request. The name is the name given to the circuit when loaded into the engine, not the circuit configuration file name. This returned value must be freed by calling free(3C).

char **annotateNodeName

The address of a pointer to a string containing the fully scoped name of the annotate node that issued the annotate request. This returned value must be freed by calling free(3C).

int32 *seqNum

A number that uniquely identifies the request within the specified annotate node. This is a returned value.

int32 *expiryTime

The UTC time when the correlation engine requires the annotate response (UNIX epoch). This is a returned value.

RETURNS

ECS_SUCCESS

Succeeded.

ESQ_NOT_MATCHED

Specified request ID not found.

WARNINGS

It is not valid to call this function after ANNO_sendResponse has been called to send an annotation response in reply to the specified request.