arm_unbind_thread(3)

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

NAME

6       arm_unbind_thread - unbind a thread
7

SYNOPSIS

9       #include <arm4.h>
10
11       arm_error_t
12       arm_unbind_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_unbind_thread()  indicates  that the thread from which it is called
19       is no longer performing on behalf of the transaction identified by  the
20       start handle.
21
22       Call  arm_unbind_thread() when a thread is no longer executing a trans‐
23       action. The thread binding is useful for managing  computing  resources
24       at  a  finer level of granularity than the process. It should be called
25       when, for this transaction and this thread, either:
26
27       *      arm_bind_thread() was previously called, or
28
29       *      The ARM_FLAG_BIND_THREAD flag was set in the  arm_start_transac‐
30              tion() call.
31
32       arm_stop_transaction()  is  an  implicit  arm_unbind_thread()  for  any
33       threads still bound  to  the  transaction  instance  [arm_bind_thread()
34       issued without a matching arm_unbind_thread()]. As long as the transac‐
35       tion is bound to the thread when the  arm_stop_transaction()  executes,
36       there  is  no  need nor any value in calling arm_unbind_thread() before
37       calling arm_stop_transaction().
38
39       buffer4 is a pointer to the user data buffer, if any. If the pointer is
40       null,  there is no buffer. No sub-buffer types are currently valid with
41       this function call, so the pointer should be null (ARM_BUF4_NONE).
42
43       flags contains 32-bit flags. No values are currently defined. The field
44       should be zero (ARM_FLAG_NONE).
45
46       tran_handle   is  a  handle  returned  in  an  out  parameter  from  an
47       arm_start_transaction() call in the same process.
48
49

RETURN VALUE

51       On success, the function returns ARM_SUCCESS. A  non-zero  value  indi‐
52       cates an error.
53

ERRORS

55       If  the  return code is negative, an error occurred. If the return code
56       is not negative, an error may or may not have occurred - the determina‐
57       tion  of  what  is an error and whether an error code is returned is at
58       the discretion of the ARM implementation. The application can test  the
59       return code if it wants to provide its own error logging.
60
61       This implementation returns no errors for arm_unbind_thread().
62

CONFORMING TO

64       ARM Issue 4.0 C Language Bindings, Version 2
65

EXAMPLE

67       None.
68