diff options
Diffstat (limited to 'native/src/include')
-rw-r--r-- | native/src/include/akka_serial.h | 103 | ||||
-rw-r--r-- | native/src/include/akka_serial_sync_UnsafeSerial.h | 45 | ||||
-rw-r--r-- | native/src/include/akka_serial_sync_UnsafeSerial__.h | 29 |
3 files changed, 177 insertions, 0 deletions
diff --git a/native/src/include/akka_serial.h b/native/src/include/akka_serial.h new file mode 100644 index 0000000..23507a9 --- /dev/null +++ b/native/src/include/akka_serial.h @@ -0,0 +1,103 @@ +#ifndef AKKA_SERIAL_H +#define AKKA_SERIAL_H + +#ifdef __cplusplus +extern "C" { +#endif + +#include <stdbool.h> +#include <stddef.h> + +// general error codes, whose that are returned by functions +#define E_IO 1 // IO error +#define E_ACCESS_DENIED 2 // access denied +#define E_BUSY 3 // port is busy +#define E_INVALID_SETTINGS 4 // some port settings are invalid +#define E_INTERRUPT 5 // not really an error, function call aborted because port is closed +#define E_NO_PORT 6 // requested port does not exist + +#define PARITY_NONE 0 +#define PARITY_ODD 1 +#define PARITY_EVEN 2 + +/** + * Contains internal configuration of an open serial port. + */ +struct serial_config; + +/** + * Opens a serial port and allocates memory for storing configuration. Note: if this function fails, + * any internally allocated resources will be freed. + * @param port_name name of port + * @param baud baud rate + * @param char_size character size of data transmitted through serial device + * @param two_stop_bits set to use two stop bits instead of one + * @param parity kind of parity checking to use + * @param serial pointer to memory that will be allocated with a serial structure + * @return 0 on success + * @return -E_NO_PORT if the given port does not exist + * @return -E_ACCESS_DENIED if permissions are not sufficient to open port + * @return -E_BUSY if port is already in use + * @return -E_INVALID_SETTINGS if any of the specified settings are invalid + * @return -E_IO on other error + */ +int serial_open( + const char* port_name, + int baud, + int char_size, + bool two_stop_bits, + int parity, + struct serial_config** const serial); + +/** + * Closes a previously opened serial port and frees memory containing the configuration. Note: after a call to + * this function, the 'serial' pointer will become invalid, make sure you only call it once. This function is NOT + * thread safe, make sure no read or write is in prgress when this function is called (the reason is that per + * close manual page, close should not be called on a file descriptor that is in use by another thread). + * @param serial pointer to serial configuration that is to be closed (and freed) + * @return 0 on success + * @return -E_IO on error + */ +int serial_close(struct serial_config* const serial); + +/** + * Starts a read from a previously opened serial port. The read is blocking, however it may be + * interrupted by calling 'serial_cancel_read' on the given serial port. + * @param serial pointer to serial configuration from which to read + * @param buffer buffer into which data is read + * @param size maximum buffer size + * @return n>0 the number of bytes read into buffer + * @return -E_INTERRUPT if the call to this function was interrupted + * @return -E_IO on IO error + */ +int serial_read(struct serial_config* const serial, char* const buffer, size_t size); + +/** + * Cancels a blocked read call. This function is thread safe, i.e. it may be called from a thread even + * while another thread is blocked in a read call. + * @param serial_config the serial port to interrupt + * @return 0 on success + * @return -E_IO on error + */ +int serial_cancel_read(struct serial_config* const serial); + +/** + * Writes data to a previously opened serial port. Non bocking. + * @param serial pointer to serial configuration to which to write + * @param data data to write + * @param size number of bytes to write from data + * @return n>0 the number of bytes written + * @return -E_IO on IO error + */ +int serial_write(struct serial_config* const serial, char* const data, size_t size); + +/** + * Sets debugging option. If debugging is enabled, detailed error message are printed from method calls. + */ +void serial_debug(bool value); + +#ifdef __cplusplus +} +#endif + +#endif /* AKKA_SERIAL_H */ diff --git a/native/src/include/akka_serial_sync_UnsafeSerial.h b/native/src/include/akka_serial_sync_UnsafeSerial.h new file mode 100644 index 0000000..893ccf6 --- /dev/null +++ b/native/src/include/akka_serial_sync_UnsafeSerial.h @@ -0,0 +1,45 @@ +/* DO NOT EDIT THIS FILE - it is machine generated */ +#include <jni.h> +/* Header for class akka_serial_sync_UnsafeSerial */ + +#ifndef _Included_akka_serial_sync_UnsafeSerial +#define _Included_akka_serial_sync_UnsafeSerial +#ifdef __cplusplus +extern "C" { +#endif +/* + * Class: akka_serial_sync_UnsafeSerial + * Method: read + * Signature: (Ljava/nio/ByteBuffer;)I + */ +JNIEXPORT jint JNICALL Java_akka_serial_sync_UnsafeSerial_read + (JNIEnv *, jobject, jobject); + +/* + * Class: akka_serial_sync_UnsafeSerial + * Method: cancelRead + * Signature: ()V + */ +JNIEXPORT void JNICALL Java_akka_serial_sync_UnsafeSerial_cancelRead + (JNIEnv *, jobject); + +/* + * Class: akka_serial_sync_UnsafeSerial + * Method: write + * Signature: (Ljava/nio/ByteBuffer;I)I + */ +JNIEXPORT jint JNICALL Java_akka_serial_sync_UnsafeSerial_write + (JNIEnv *, jobject, jobject, jint); + +/* + * Class: akka_serial_sync_UnsafeSerial + * Method: close + * Signature: ()V + */ +JNIEXPORT void JNICALL Java_akka_serial_sync_UnsafeSerial_close + (JNIEnv *, jobject); + +#ifdef __cplusplus +} +#endif +#endif diff --git a/native/src/include/akka_serial_sync_UnsafeSerial__.h b/native/src/include/akka_serial_sync_UnsafeSerial__.h new file mode 100644 index 0000000..5f4bdb9 --- /dev/null +++ b/native/src/include/akka_serial_sync_UnsafeSerial__.h @@ -0,0 +1,29 @@ +/* DO NOT EDIT THIS FILE - it is machine generated */ +#include <jni.h> +/* Header for class akka_serial_sync_UnsafeSerial__ */ + +#ifndef _Included_akka_serial_sync_UnsafeSerial__ +#define _Included_akka_serial_sync_UnsafeSerial__ +#ifdef __cplusplus +extern "C" { +#endif +/* + * Class: akka_serial_sync_UnsafeSerial__ + * Method: open + * Signature: (Ljava/lang/String;IIZI)J + */ +JNIEXPORT jlong JNICALL Java_akka_serial_sync_UnsafeSerial_00024_open + (JNIEnv *, jobject, jstring, jint, jint, jboolean, jint); + +/* + * Class: akka_serial_sync_UnsafeSerial__ + * Method: debug + * Signature: (Z)V + */ +JNIEXPORT void JNICALL Java_akka_serial_sync_UnsafeSerial_00024_debug + (JNIEnv *, jobject, jboolean); + +#ifdef __cplusplus +} +#endif +#endif |