/usr/include/mirclient/mir_toolkit/mir_prompt_session.h is in libmirclient-dev 0.26.3+16.04.20170605-0ubuntu1.1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 | /*
* Copyright © 2014 Canonical Ltd.
*
* This program is free software: you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License version 3,
* as published by the Free Software Foundation.
*
* This program 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 program. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef MIR_TOOLKIT_MIR_PROMPT_SESSION_H_
#define MIR_TOOLKIT_MIR_PROMPT_SESSION_H_
#include "mir_toolkit/mir_client_library.h"
#include <sys/types.h>
#include <stdbool.h>
#ifdef __cplusplus
/**
* \addtogroup mir_toolkit
* @{
*/
extern "C" {
#endif
/**
* Create and start a new prompt session
* \param [in] connection The connection
* \param [in] application_pid The process id of the initiating application
* \param [in] state_change_callback The function to be called when a prompt session state change occurs
* \param [in,out] context User data passed to the callback functions
* \return A handle that can be passed to mir_wait_for
*/
MirPromptSession *mir_connection_create_prompt_session_sync(
MirConnection* connection,
pid_t application_pid,
MirPromptSessionStateChangeCallback state_change_callback,
void *context);
/**
* Allocate some FDs for prompt providers to connect on
*
* Prompt helpers need to allocate connection FDs it will pass to
* prompt providers to use when connecting to the server. The server can
* then associate them with the prompt session.
*
* \warning This API is tentative until the implementation of prompt sessions is complete
* \param [in] prompt_session The prompt session
* \param [in] no_of_fds The number of fds to allocate
* \param [in] callback Callback invoked when request completes
* \param [in,out] context User data passed to the callback function
* \return A handle that can be passed to mir_wait_for
*/
MirWaitHandle* mir_prompt_session_new_fds_for_prompt_providers(
MirPromptSession *prompt_session,
unsigned int no_of_fds,
MirClientFdCallback callback,
void * context);
/**
* Allocate some FDs for prompt providers to connect on
*
* Prompt helpers need to allocate connection FDs it will pass to
* prompt providers to use when connecting to the server. The server can
* then associate them with the prompt session.
*
* \warning This API is tentative until the implementation of prompt sessions is complete
* \param [in] prompt_session The prompt session
* \param [in] no_of_fds The number of fds to allocate
* \param [out] fds An int array of at least size no_of_fds
* \return The number of fds actually allocated
*/
size_t mir_prompt_session_new_fds_for_prompt_providers_sync(
MirPromptSession *prompt_session,
unsigned int no_of_fds,
int* fds);
/**
* Stop and release the specified prompt session
* \param [in] prompt_session The prompt session
*/
void mir_prompt_session_release_sync(MirPromptSession *prompt_session);
/**
* Test for a valid prompt session
* \param [in] prompt_session The prompt session
* \return True if prompt_session is valid, false otherwise
*/
bool mir_prompt_session_is_valid(MirPromptSession *prompt_session);
/**
* Retrieve a text description of the last error. The returned string is owned
* by the library and remains valid until the prompt session has been released.
* \param [in] prompt_session The prompt session
* \return A text description of any error resulting in an
* invalid connection, or the empty string "" if the
* connection is valid.
*/
char const *mir_prompt_session_error_message(MirPromptSession *prompt_session);
#ifdef __cplusplus
}
/**@}*/
#endif
#endif /* MIR_TOOLKIT_MIR_PROMPT_SESSION_H_ */
|