| 1 | .\" Copyright (c) 2005-2008 David Carter <dcarter@arm4.org> and others. |
|---|
| 2 | .\" All rights reserved. This program and the accompanying materials |
|---|
| 3 | .\" are made available under the terms of the Eclipse Public License v1.0 |
|---|
| 4 | .\" which accompanies this distribution, and is available at |
|---|
| 5 | .\" http://www.eclipse.org/legal/epl-v10.html |
|---|
| 6 | .TH "arm_bind_thread" 3 "August 2008" "arm4.org" "ARM 4 Programmer's Manual" |
|---|
| 7 | .SH NAME |
|---|
| 8 | arm_bind_thread \- bind thread |
|---|
| 9 | .SH SYNOPSIS |
|---|
| 10 | .B #include <arm4.h> |
|---|
| 11 | .sp |
|---|
| 12 | \fBarm_error_t |
|---|
| 13 | .br |
|---|
| 14 | arm_bind_thread( |
|---|
| 15 | .br |
|---|
| 16 | const arm_tran_start_handle_t \fItran_handle\fB, |
|---|
| 17 | .br |
|---|
| 18 | const arm_int32_t \fIflags\fB, |
|---|
| 19 | .br |
|---|
| 20 | const arm_buffer4_t *\fIbuffer4\fB);\fR |
|---|
| 21 | .SH DESCRIPTION |
|---|
| 22 | \fBarm_bind_thread()\fR indicates that the thread from which it is called is performing on behalf of |
|---|
| 23 | the transaction identified by the start handle. |
|---|
| 24 | |
|---|
| 25 | The thread binding could be useful for managing computing resources at a finer level of |
|---|
| 26 | granularity than a process. There can be any number of threads simultaneously bound to the |
|---|
| 27 | same transaction. |
|---|
| 28 | |
|---|
| 29 | A transaction remains bound to a thread until either an \fBarm_discard_transaction()\fR, |
|---|
| 30 | \fBarm_stop_transaction()\fR, or \fBarm_unbind_thread()\fR is executed passing the same start handle. |
|---|
| 31 | |
|---|
| 32 | \fBarm_bind_thread()\fR and \fBarm_block_transaction()\fR are used independently of each other. |
|---|
| 33 | |
|---|
| 34 | \fItran_handle\fR is a handle returned from an \fBarm_start_transaction()\fR call in the |
|---|
| 35 | same process. |
|---|
| 36 | |
|---|
| 37 | No sub-buffer types are currently valid with this function call, so the \fIbuffer4\fR pointer should be |
|---|
| 38 | null (\fBARM_BUF4_NONE\fR). |
|---|
| 39 | |
|---|
| 40 | No values are currently defined for \fIflags\fR. The field should be zero |
|---|
| 41 | (\fBARM_FLAG_NONE\fR). |
|---|
| 42 | |
|---|
| 43 | .SH "RETURN VALUE" |
|---|
| 44 | On success, the function returns \fBARM_SUCCESS\fR. A non-zero value indicates |
|---|
| 45 | an error. |
|---|
| 46 | .SH ERRORS |
|---|
| 47 | If the return code is negative, an error occurred. If the return code is not negative, an error may |
|---|
| 48 | or may not have occurred - the determination of what is an error and whether an error code is |
|---|
| 49 | returned is at the discretion of the ARM implementation. The application can test the return code |
|---|
| 50 | if it wants to provide its own error logging. |
|---|
| 51 | |
|---|
| 52 | This implementation returns no errors for \fBarm_bind_thread()\fR. |
|---|
| 53 | .SH "CONFORMING TO" |
|---|
| 54 | ARM Issue 4.0 C Language Bindings, Version 2 |
|---|
| 55 | .SH EXAMPLE |
|---|
| 56 | None. |
|---|
| 57 | .SH "SEE ALSO" |
|---|
| 58 | .BR arm_unbind_thread (3), |
|---|
| 59 | .BR arm_block_transaction (3), |
|---|
| 60 | .BR arm_start_transaction (3), |
|---|
| 61 | .BR arm_discard_transaction (3), |
|---|
| 62 | .BR arm_stop_transaction (3) |
|---|
