arm_bind_thread(3)

1arm_bind_thread(3)         ARM 4 Programmer's Manual        arm_bind_thread(3)
2
3
4

NAME

6       arm_bind_thread - bind thread
7

SYNOPSIS

9       #include <arm4.h>
10
11       arm_error_t
12       arm_bind_thread(
13           const arm_tran_start_handle_t tran_handle,
14           const arm_int32_t flags,
15           const arm_buffer4_t *buffer4);
16

DESCRIPTION

18       arm_bind_thread()  indicates that the thread from which it is called is
19       performing on behalf of the transaction identified by the start handle.
20
21       The thread binding could be useful for managing computing resources  at
22       a finer level of granularity than a process. There can be any number of
23       threads simultaneously bound to the same transaction.
24
25       A transaction remains bound  to  a  thread  until  either  an  arm_dis‐
26       card_transaction(),  arm_stop_transaction(),  or arm_unbind_thread() is
27       executed passing the same start handle.
28
29       arm_bind_thread() and arm_block_transaction() are used independently of
30       each other.
31
32       tran_handle  is  a handle returned from an arm_start_transaction() call
33       in the same process.
34
35       No sub-buffer types are currently valid with this function call, so the
36       buffer4 pointer should be null (ARM_BUF4_NONE).
37
38       No  values  are  currently  defined for flags. The field should be zero
39       (ARM_FLAG_NONE).
40
41

RETURN VALUE

43       On success, the function returns ARM_SUCCESS. A  non-zero  value  indi‐
44       cates an error.
45

ERRORS

47       If  the  return code is negative, an error occurred. If the return code
48       is not negative, an error may or may not have occurred - the determina‐
49       tion  of  what  is an error and whether an error code is returned is at
50       the discretion of the ARM implementation. The application can test  the
51       return code if it wants to provide its own error logging.
52
53       This implementation returns no errors for arm_bind_thread().
54

CONFORMING TO

56       ARM Issue 4.0 C Language Bindings, Version 2
57

EXAMPLE

59       None.
60