Programs/api_server.h

/*
 * BRLTTY - A background process providing access to the console screen (when in
 *          text mode) for a blind person using a refreshable braille display.
 *
 * Copyright (C) 1995-2023 by The BRLTTY Developers.
 *
 * BRLTTY comes with ABSOLUTELY NO WARRANTY.
 *
 * This is free software, placed 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. Please see the file LICENSE-LGPL for details.
 *
 * Web Page: http://brltty.app/
 *
 * This software is maintained by Dave Mielke <dave@mielke.cc>.
 */

#ifndef BRLTTY_INCLUDED_API_SERVER
#define BRLTTY_INCLUDED_API_SERVER

#include "brl_types.h"

#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */

extern void api_logServerIdentity (int full);
extern const char *const api_serverParameters[];

extern int api_startServer (BrailleDisplay *brl, char **parameters);
extern void api_stopServer (BrailleDisplay *brl);

extern void api_linkServer (BrailleDisplay *brl);
extern void api_unlinkServer (BrailleDisplay *brl);

extern void api_suspendDriver (BrailleDisplay *brl);
extern int api_resumeDriver (BrailleDisplay *brl);

extern int api_claimDriver (BrailleDisplay *brl);
extern void api_releaseDriver (BrailleDisplay *brl);

extern int api_handleCommand (int command);
extern int api_handleKeyEvent (KeyGroup group, KeyNumber number, int press);

extern int api_flushOutput (BrailleDisplay *brl);

extern void api_updateParameter (brlapi_param_t parameter, brlapi_param_subparam_t subparam);

#ifdef __cplusplus
}
#endif /* __cplusplus */

#endif /* BRLTTY_INCLUDED_API_SERVER */