ck_hs_fas (3) - Linux Man Pages

ck_hs_fas: fetch and store key in hash set

NAME

ck_hs_fas - fetch and store key in hash set

LIBRARY

Concurrency Kit (libck, -lck)

SYNOPSIS

In ck_hs.h Ft bool Fn ck_hs_fas ck_hs_t *hs unsigned long hash const void *key void **previous

DESCRIPTION

The Fn ck_hs_fas 3 function will fetch and store the key specified by the Fa key argument in the hash set pointed to by the Fa hs argument. The key specified by Fa key is expected to have the hash value specified by the Fa hash argument (which was previously generated using the CK_HS_HASH3 macro).

If the call to Fn ck_hs_fas 3 was successful then the key specified by Fa key was successfully stored in the hash set pointed to by Fa hs . The key must already exist in the hash set, and is replaced by Fa key and the previous value is stored into the void pointer pointed to by the Fa previous argument. If the key does not exist in the hash set then the function will return false and the hash set is unchanged. This function is guaranteed to be stable with respect to memory usage.

RETURN VALUES

Upon successful completion, Fn ck_hs_fas 3 returns true and otherwise returns false on failure.

ERRORS

Behavior is undefined if Fa key or Fa hs are uninitialized.

SEE ALSO

ck_hs_init3, ck_hs_move3, ck_hs_destroy3, CK_HS_HASH3, ck_hs_iterator_init3, ck_hs_next3, ck_hs_get3, ck_hs_put3, ck_hs_put_unique3, ck_hs_remove3, ck_hs_grow3, ck_hs_rebuild3, ck_hs_gc3, ck_hs_count3, ck_hs_reset3, ck_hs_reset_size3, ck_hs_stat3

Additional information available at http://concurrencykit.org/