NAME

arm_bind_thread - bind thread

SYNOPSIS

#include <arm4.h>

arm_error_t
arm_bind_thread(

 const arm_tran_start_handle_t 
tran_handle

 const arm_int32_t 
flags,

 const arm_buffer4_t *
buffer4);

DESCRIPTION

arm_bind_thread() indicates that the thread from which it is called is performing on behalf of the transaction identified by the start handle.

The thread binding could be useful for managing computing resources at a finer level of granularity than a process. There can be any number of threads simultaneously bound to the same transaction.

A transaction remains bound to a thread until either an arm_discard_transaction(), arm_stop_transaction(), or arm_unbind_thread() is executed passing the same start handle.

arm_bind_thread() and arm_block_transaction() are used independently of each other.

tran_handle is a handle returned from an arm_start_transaction() call in the same process.

No sub-buffer types are currently valid with this function call, so the buffer4 pointer should be null (ARM_BUF4_NONE).

No values are currently defined for flags. The field should be zero (ARM_FLAG_NONE).

RETURN VALUE

On success, the function returns ARM_SUCCESS. A non-zero value indicates an error.

ERRORS

If the return code is negative, an error occurred. If the return code is not negative, an error may or may not have occurred - the determination of what is an error and whether an error code is returned is at the discretion of the ARM implementation. The application can test the return code if it wants to provide its own error logging.

This implementation returns no errors for arm_bind_thread().

CONFORMING TO

ARM Issue 4.0 C Language Bindings, Version 2

EXAMPLE

None.

SEE ALSO

arm_unbind_thread(3), arm_block_transaction(3), arm_start_transaction(3), arm_discard_transaction(3), arm_stop_transaction(3)