mirror of
https://gitlab.freedesktop.org/pulseaudio/pulseaudio.git
synced 2025-11-02 09:01:46 -05:00
22cb23eedb
split polyplib to multiple modules add some prelimenary documentation add doxygen support git-svn-id: file:///home/lennart/svn/public/pulseaudio/trunk@123 fefdeb5f-60dc-0310-8127-8f9354f1896f
92 lines
3.5 KiB
C
92 lines
3.5 KiB
C
#ifndef foopolyplibcontexthfoo
|
|
#define foopolyplibcontexthfoo
|
|
|
|
/* $Id$ */
|
|
|
|
/***
|
|
This file is part of polypaudio.
|
|
|
|
polypaudio is free software; you can redistribute it and/or modify
|
|
it under the terms of the GNU General Public License as published
|
|
by the Free Software Foundation; either version 2 of the License,
|
|
or (at your option) any later version.
|
|
|
|
polypaudio 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
|
|
General Public License for more details.
|
|
|
|
You should have received a copy of the GNU General Public License
|
|
along with polypaudio; if not, write to the Free Software
|
|
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
|
|
USA.
|
|
***/
|
|
|
|
#include "sample.h"
|
|
#include "polyplib-def.h"
|
|
#include "mainloop-api.h"
|
|
#include "cdecl.h"
|
|
#include "polyplib-operation.h"
|
|
|
|
/** \file
|
|
* Connection contexts */
|
|
|
|
PA_C_DECL_BEGIN
|
|
|
|
/** The state of a connection context */
|
|
enum pa_context_state {
|
|
PA_CONTEXT_UNCONNECTED, /**< The context hasn't been connected yet */
|
|
PA_CONTEXT_CONNECTING, /**< A connection is being established */
|
|
PA_CONTEXT_AUTHORIZING, /**< The client is authorizing itself to the daemon */
|
|
PA_CONTEXT_SETTING_NAME, /**< The client is passing its application name to the daemon */
|
|
PA_CONTEXT_READY, /**< The connection is established, the context is ready to execute operations */
|
|
PA_CONTEXT_FAILED, /**< The connection failed or was disconnected */
|
|
PA_CONTEXT_TERMINATED /**< The connect was terminated cleanly */
|
|
};
|
|
|
|
/** \struct pa_context
|
|
* A connection context to a daemon */
|
|
struct pa_context;
|
|
|
|
/** Instantiate a new connection context with an abstract mainloop API
|
|
* and an application name */
|
|
struct pa_context *pa_context_new(struct pa_mainloop_api *mainloop, const char *name);
|
|
|
|
/** Decrease the reference counter of the context by one */
|
|
void pa_context_unref(struct pa_context *c);
|
|
|
|
/** Increase the reference counter of the context by one */
|
|
struct pa_context* pa_context_ref(struct pa_context *c);
|
|
|
|
/** Set a callback function that is called whenever the context status changes */
|
|
void pa_context_set_state_callback(struct pa_context *c, void (*cb)(struct pa_context *c, void *userdata), void *userdata);
|
|
|
|
/** Return the error number of the last failed operation */
|
|
int pa_context_errno(struct pa_context *c);
|
|
|
|
/** Return non-zero if some data is pending to be written to the connection */
|
|
int pa_context_is_pending(struct pa_context *c);
|
|
|
|
/** Return the current context status */
|
|
enum pa_context_state pa_context_get_state(struct pa_context *c);
|
|
|
|
/** Connect the context to the specified server. If server is NULL,
|
|
connect to the default server. This routine may but will not always
|
|
return synchronously on error. Use pa_context_set_state_callback() to
|
|
be notified when the connection is established */
|
|
int pa_context_connect(struct pa_context *c, const char *server);
|
|
|
|
/** Terminate the context connection immediately */
|
|
void pa_context_disconnect(struct pa_context *c);
|
|
|
|
/** Drain the context. If there is nothing to drain, the function returns NULL */
|
|
struct pa_operation* pa_context_drain(struct pa_context *c, void (*cb) (struct pa_context*c, void *userdata), void *userdata);
|
|
|
|
/** Tell the daemon to exit. No operation object is returned as the
|
|
* connection is terminated when the daemon quits, thus this operation
|
|
* would never complete. */
|
|
void pa_context_exit_daemon(struct pa_context *c);
|
|
|
|
PA_C_DECL_END
|
|
|
|
#endif
|