diff options
| author | Tanu Kaskinen <tanuk@iki.fi> | 2013-01-12 18:35:41 +0200 |
|---|---|---|
| committer | Tanu Kaskinen <tanuk@iki.fi> | 2013-03-13 16:10:16 +0200 |
| commit | 7e1ebf9455cc989059ed853413f29e639c7c594c (patch) | |
| tree | 915bed2c2ad71d22ae466999a4e2e685a6ecd65e | |
| parent | 759f82f17d81e38927c030d25370f21b7ce11a06 (diff) | |
pulse: Document the operation state behavior on context disconnection.
| -rw-r--r-- | src/pulse/def.h | 11 | ||||
| -rw-r--r-- | src/pulse/operation.h | 8 |
2 files changed, 14 insertions, 5 deletions
diff --git a/src/pulse/def.h b/src/pulse/def.h index f8c2a5f4..495302f8 100644 --- a/src/pulse/def.h +++ b/src/pulse/def.h @@ -93,9 +93,14 @@ static inline int PA_STREAM_IS_GOOD(pa_stream_state_t x) { /** The state of an operation */ typedef enum pa_operation_state { - PA_OPERATION_RUNNING, /**< The operation is still running */ - PA_OPERATION_DONE, /**< The operation has been completed */ - PA_OPERATION_CANCELLED /**< The operation has been cancelled. Before 0.9.18 this was called PA_OPERATION_CANCELED. That name is still available for compatibility. */ + PA_OPERATION_RUNNING, + /**< The operation is still running */ + PA_OPERATION_DONE, + /**< The operation has been completed */ + PA_OPERATION_CANCELLED + /**< The operation has been cancelled. Operations may get cancelled by the + * application, or as a result of the context getting disconneted while the + * operation is pending. */ } pa_operation_state_t; /** \cond fulldocs */ diff --git a/src/pulse/operation.h b/src/pulse/operation.h index 4d5aa2be..82e97c91 100644 --- a/src/pulse/operation.h +++ b/src/pulse/operation.h @@ -53,8 +53,12 @@ void pa_operation_cancel(pa_operation *o); /** Return the current status of the operation */ pa_operation_state_t pa_operation_get_state(pa_operation *o); -/** Set the callback function that is called when the operation - * is canceled due to disconnection. \since 4.0 */ +/** Set the callback function that is called when the operation state + * changes. Usually this is not necessary, since the functions that + * create pa_operation objects already take a callback that is called + * when the operation finishes. Registering a state change callback is + * mainly useful, if you want to get called back also if the operation + * gets cancelled. \since 4.0 */ void pa_operation_set_state_callback(pa_operation *o, pa_operation_notify_cb_t cb, void *userdata); PA_C_DECL_END |