-
Notifications
You must be signed in to change notification settings - Fork 20
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Provide additional IPC interface to read and write
Lv2 control ports from external processes Signed-off-by: Timo Wischer <[email protected]>
- Loading branch information
Showing
8 changed files
with
4,890 additions
and
6 deletions.
There are no files selected for viewing
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,67 @@ | ||
/* | ||
Copyright 2017 Timo Wischer <[email protected]> | ||
Permission to use, copy, modify, and/or distribute this software for any | ||
purpose with or without fee is hereby granted, provided that the above | ||
copyright notice and this permission notice appear in all copies. | ||
THIS SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES | ||
WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF | ||
MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR | ||
ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES | ||
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN | ||
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF | ||
OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. | ||
*/ | ||
|
||
#ifndef CONTROL_API_H | ||
#define CONTROL_API_H | ||
|
||
/** | ||
* @addtogroup Internal | ||
* @{ | ||
* @name Control API | ||
* @{ | ||
* | ||
* @brief The following functions are used to handle the API. | ||
* These functions are only used internally | ||
*/ | ||
|
||
#include "jalv.h" | ||
#include "jalv_internal.h" | ||
|
||
/** | ||
* @brief api_ctl_init creates and initilizes all required IPC mechanismen | ||
* @param jalv | ||
* @return <0 on error | ||
*/ | ||
int jalv_api_ctl_init(Jalv* const jalv); | ||
|
||
/** | ||
* @brief api_ctl_lock has to be called before the control port data will be changed | ||
* @param jalv | ||
* @return <0 on error | ||
* This function will be called from real time context | ||
*/ | ||
int jalv_api_ctl_lock(Jalv* const jalv, const bool process_requests); | ||
|
||
/** | ||
* @brief api_ctl_unlock has to be called to provide the changed control data to the IPC clients | ||
* @param jalv | ||
* @return <0 on error | ||
*/ | ||
int jalv_api_ctl_unlock(Jalv* const jalv, const bool trigger_events); | ||
|
||
/** | ||
* @brief jalv_api_ctl_destroy frees all internal ressources of the JALV API | ||
* @param jalv | ||
*/ | ||
void jalv_api_ctl_destroy(Jalv* const jalv); | ||
|
||
/** | ||
@endcond | ||
@} | ||
@} | ||
*/ | ||
|
||
#endif // CONTROL_API_H |
Oops, something went wrong.