1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50

// Copyright 2017 Lyndon Brown
//
// This file is part of the PulseAudio Rust language linking library.
//
// This library is free software; you can redistribute it and/or modify it under the terms of the
// GNU Lesser General Public License as published by the Free Software Foundation; either version
// 2.1 of the License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without
// even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License along with this library;
// if not, see <http://www.gnu.org/licenses/>.

//! Asynchronous operations.

use std::os::raw::c_void;

/// An asynchronous operation object.
#[repr(C)] pub struct pa_operation { _private: [u8; 0] }

#[repr(C)]
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
pub enum pa_operation_state_t {
    /// The operation is still running.
    Running,
    /// The operation has completed.
    Done,
    /// The operation has been cancelled. Operations may get cancelled by the application, or as a
    /// result of the context getting disconnected while the operation is pending.
    Cancelled,
}

pub const PA_OPERATION_RUNNING: pa_operation_state_t = pa_operation_state_t::Running;
pub const PA_OPERATION_DONE: pa_operation_state_t = pa_operation_state_t::Done;
pub const PA_OPERATION_CANCELED: pa_operation_state_t = pa_operation_state_t::Cancelled;
pub const PA_OPERATION_CANCELLED: pa_operation_state_t = pa_operation_state_t::Cancelled;

/// A callback for operation state changes.
pub type pa_operation_notify_cb_t = Option<extern "C" fn(o: *mut pa_operation, userdata: *mut c_void)>;

#[link(name="pulse")]
extern "C" {
    pub fn pa_operation_ref(o: *mut pa_operation) -> *mut pa_operation;
    pub fn pa_operation_unref(o: *mut pa_operation);
    pub fn pa_operation_cancel(o: *mut pa_operation);
    pub fn pa_operation_get_state(o: *const pa_operation) -> pa_operation_state_t;
    pub fn pa_operation_set_state_callback(o: *mut pa_operation, cb: pa_operation_notify_cb_t, userdata: *mut c_void);
}