journal functions

Adaptive Function to_string<ipAddress> More...

Functions
const afw_value_t *	afw_function_execute_journal_advance_cursor_for_consumer (afw_function_execute_t *x)
	Adaptive Function journal_advance_cursor_for_consumer More...
const afw_value_t *	afw_function_execute_journal_get_by_cursor (afw_function_execute_t *x)
	Adaptive Function journal_get_by_cursor More...
const afw_value_t *	afw_function_execute_journal_get_first (afw_function_execute_t *x)
	Adaptive Function journal_get_first More...
const afw_value_t *	afw_function_execute_journal_get_next_after_cursor (afw_function_execute_t *x)
	Adaptive Function journal_get_next_after_cursor More...
const afw_value_t *	afw_function_execute_journal_get_next_for_consumer (afw_function_execute_t *x)
	Adaptive Function journal_get_next_for_consumer More...
const afw_value_t *	afw_function_execute_journal_get_next_for_consumer_after_cursor (afw_function_execute_t *x)
	Adaptive Function journal_get_next_for_consumer_after_cursor More...
const afw_value_t *	afw_function_execute_journal_mark_consumed (afw_function_execute_t *x)
	Adaptive Function journal_mark_consumed More...

Variables
	afw_function_definition_journal_advance_cursor_for_consumer
	Function definition journal_advance_cursor_for_consumer.
	afw_function_definition_journal_get_by_cursor
	Function definition journal_get_by_cursor.
	afw_function_definition_journal_get_first
	Function definition journal_get_first.
	afw_function_definition_journal_get_next_after_cursor
	Function definition journal_get_next_after_cursor.
	afw_function_definition_journal_get_next_for_consumer
	Function definition journal_get_next_for_consumer.
	afw_function_definition_journal_get_next_for_consumer_after_cursor
	Function definition journal_get_next_for_consumer_after_cursor.
	afw_function_definition_journal_mark_consumed
	Function definition journal_mark_consumed.

Detailed Description

Adaptive Function to_string<ipAddress>

Parameters

x	function execute parameter.

Converts ipAddress value to string. For list values, the to_string() value for each entry is returned separated with commas.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Declaration:

function to_string<ipAddress>(
    value: ipAddress
): string;

Parameters:

value - (ipAddress) A ipAddress value.

Returns:

(string) The string representation of the value.

Implemented by afw_function_execute_convert()

---

journal adaptive functions.

Function Documentation

afw_function_execute_journal_advance_cursor_for_consumer()

const afw_value_t* afw_function_execute_journal_advance_cursor_for_consumer

(

afw_function_execute_t *

x

)

Adaptive Function journal_advance_cursor_for_consumer

Parameters

x	function execute parameter.

Update the advance cursor for a consumer referenced by the consumerId parameter. The limit parameter specifies the maximum number of entries to scan for an applicable entry for consumer before returning. NULL is always returned.

There are no response properties set by this function.

The properties of the AdaptiveProvisioningPeer object associated with the consumer_id are used in the following way:

The consumerFilter expression is used to determine if an entry is applicable.

Journal entries are scanned beginning at the entry at the cursor in the advanceCursor property. If the advanceCursor property is not present, the scan begins after the cursor in currentCursor. If neither are present, the scan begins at the start of the journal.

If an new applicable entry is found or if the limit is met, the advanceCursor property is set to the currently scanned entry's cursor.

This function is not pure, so it may return a different result given exactly the same parameters and has side effects.

Declaration:

function journal_advance_cursor_for_consumer(
    adaptorId: string,
    consumerId: string,
    limit?: integer
): object;

Parameters:

adaptorId - (string) Id of adaptor.

consumerId - (string) The consumerId property value of the associated AdaptiveProvisioningPeer object.

limit - (optional integer) The maximum number of entries that will be scanned for an entry where the consumerFilter expression in the associated AdaptiveProvisioningPeer object evaluates to true.

Returns:

(object) Response object.

Definition at line 75 of file afw_function_journal.c.

afw_function_execute_journal_get_by_cursor()

const afw_value_t* afw_function_execute_journal_get_by_cursor

(

afw_function_execute_t *

x

)

Adaptive Function journal_get_by_cursor

Parameters

x	function execute parameter.

Get journal entry specified by entry_cursor parameter.

This option will set response properties "entry" and "cursor" if there is an entry to retrieve. If an entry with the supplied cursor does not exist, a not_found error is thrown.

This function is not pure, so it may return a different result given exactly the same parameters.

Declaration:

function journal_get_by_cursor(
    adaptorId: string,
    cursor: string
): object;

Parameters:

adaptorId - (string) Id of adaptor.

cursor - (string) Journal entry cursor.

Returns:

(object) Response object.

Definition at line 135 of file afw_function_journal.c.

afw_function_execute_journal_get_first()

const afw_value_t* afw_function_execute_journal_get_first

(

afw_function_execute_t *

x

)

Adaptive Function journal_get_first

Parameters

x	function execute parameter.

Get first journal entry.

This option will set response properties "entry" and "cursor" if there is a first entry to return.

This function is not pure, so it may return a different result given exactly the same parameters.

Declaration:

function journal_get_first(
    adaptorId: string
): object;

Parameters:

adaptorId - (string) Id of adaptor.

Returns:

(object) Response object.

Definition at line 184 of file afw_function_journal.c.

afw_function_execute_journal_get_next_after_cursor()

const afw_value_t* afw_function_execute_journal_get_next_after_cursor

(

afw_function_execute_t *

x

)

Adaptive Function journal_get_next_after_cursor

Parameters

x	function execute parameter.

Get the next journal entry after the one specified by the entry_cursor parameter.

This option will set response properties "entry" and "cursor" if there is a next entry to retrieve.

This function is not pure, so it may return a different result given exactly the same parameters.

Declaration:

function journal_get_next_after_cursor(
    adaptorId: string,
    cursor: string
): object;

Parameters:

adaptorId - (string) Id of adaptor.

cursor - (string) Journal entry cursor.

Returns:

(object) Response object.

Definition at line 235 of file afw_function_journal.c.

afw_function_execute_journal_get_next_for_consumer()

const afw_value_t* afw_function_execute_journal_get_next_for_consumer

(

afw_function_execute_t *

x

)

Adaptive Function journal_get_next_for_consumer

Parameters

x	function execute parameter.

Get the next journal entry for a consumer referenced by the consumer_id parameter. The entry_cursor parameter is ignored. The limit parameter specifies the maximum number of entries to scan for an applicable entry for consumer before returning.

This option will set response properties "entry" and "entryCursor" if an applicable entry is retrieved. Property "reissue" will be set as described below.

The properties of the AdaptiveProvisioningPeer object associated with the consumer_id are used in the following way:

The consumerFilter expression is used to determine if an entry is applicable.

If consumeCursor property exists, return that entry at that cursor again immediately with a "reissue" property added and set to true.

Journal entries are scanned beginning at the entry at the cursor in the advanceCursor property. If the advanceCursor property is not present, the scan begins after the cursor in currentCursor. If neither are present, the scan begins at the start of the journal.

If an applicable entry is found, properties consumeStart and consumeCursor are set, advanceCursor is removed, and the entry is returned. Method mark_entry_consumed() will remove these properties.

If no applicable entry is found, advanceCursor is set to the last entry scanned.

This function is not pure, so it may return a different result given exactly the same parameters.

Declaration:

function journal_get_next_for_consumer(
    adaptorId: string,
    consumerId: string,
    limit?: integer
): object;

Parameters:

adaptorId - (string) Id of adaptor.

consumerId - (string) The consumerId property value of the associated AdaptiveProvisioningPeer object.

limit - (optional integer) The maximum number of entries that will be scanned for an entry where the consumerFilter expression in the associated AdaptiveProvisioningPeer object evaluates to true.

Returns:

(object) Response object.

Definition at line 318 of file afw_function_journal.c.

afw_function_execute_journal_get_next_for_consumer_after_cursor()

const afw_value_t* afw_function_execute_journal_get_next_for_consumer_after_cursor

(

afw_function_execute_t *

x

)

Adaptive Function journal_get_next_for_consumer_after_cursor

Parameters

x	function execute parameter.

Get the next journal entry for a consumer referenced by the consumer_id after the one specified by the entry_cursor parameter. The limit parameter specifies the maximum number of entries to scan for an applicable entry for consumer before returning.

This option will set response properties "entry" and "cursor" if an applicable entry is retrieved.

The properties of the AdaptiveProvisioningPeer object associated with the consumer_id are used in the following way:

The consumerFilter expression is used to determine if an entry is applicable.

Unlike option get_next_for_consumer, no other properties are referenced or modified.

This function is not pure, so it may return a different result given exactly the same parameters.

Declaration:

function journal_get_next_for_consumer_after_cursor(
    adaptorId: string,
    consumerId: string,
    cursor: string,
    limit?: integer
): object;

Parameters:

adaptorId - (string) Id of adaptor.

consumerId - (string) The consumerId property value of the associated AdaptiveProvisioningPeer object.

cursor - (string) Journal entry cursor.

limit - (optional integer) The maximum number of entries that will be scanned for an entry where the consumerFilter expression in the associated AdaptiveProvisioningPeer object evaluates to true.

Returns:

(object) Response object.

Definition at line 398 of file afw_function_journal.c.

afw_function_execute_journal_mark_consumed()

const afw_value_t* afw_function_execute_journal_mark_consumed

(

afw_function_execute_t *

x

)

Adaptive Function journal_mark_consumed

Parameters

x	function execute parameter.

Mark a journal entry returned by get_next_for_consumer() as consumed.

This function is not pure, so it may return a different result given exactly the same parameters and has side effects.

Declaration:

function journal_mark_consumed(
    adaptorId: string,
    consumerId: string,
    cursor: string
): null;

Parameters:

adaptorId - (string) Id of adaptor.

consumerId - (string) The consumerId property value of the associated AdaptiveProvisioningPeer object.

cursor - (string) Journal entry cursor.

Returns:

(null)

Definition at line 461 of file afw_function_journal.c.