include/rtems/recordserver.h

0001 /*
0002  * SPDX-License-Identifier: BSD-2-Clause
0003  *
0004  * Copyright (C) 2018, 2019 embedded brains GmbH & Co. KG
0005  *
0006  * Redistribution and use in source and binary forms, with or without
0007  * modification, are permitted provided that the following conditions
0008  * are met:
0009  * 1. Redistributions of source code must retain the above copyright
0010  *    notice, this list of conditions and the following disclaimer.
0011  * 2. Redistributions in binary form must reproduce the above copyright
0012  *    notice, this list of conditions and the following disclaimer in the
0013  *    documentation and/or other materials provided with the distribution.
0014  *
0015  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
0016  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
0017  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
0018  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
0019  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
0020  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
0021  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
0022  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
0023  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
0024  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
0025  * POSSIBILITY OF SUCH DAMAGE.
0026  */
0027
0028 #ifndef _RTEMS_RECORDSERVER_H
0029 #define _RTEMS_RECORDSERVER_H
0030
0031 #include "recorddata.h"
0032
0033 #include <sys/types.h>
0034 #include <rtems.h>
0035
0036 #ifdef __cplusplus
0037 extern "C" {
0038 #endif /* __cplusplus */
0039
0040 /**
0041  * @brief Runs a record TCP server loop.
0042  *
0043  * @param port The TCP port to listen in host byte order.
0044  * @param period The drain period in clock ticks.
0045  */
0046 void rtems_record_server( uint16_t port, rtems_interval period );
0047
0048 /**
0049  * @brief Starts a record TCP server task.
0050  *
0051  * @param priority The task priority.
0052  * @param port The TCP port to listen in host byte order.
0053  * @param period The drain period in clock ticks.
0054  */
0055 rtems_status_code rtems_record_start_server(
0056   rtems_task_priority priority,
0057   uint16_t            port,
0058   rtems_interval      period
0059 );
0060
0061 /** @} */
0062
0063 #ifdef __cplusplus
0064 }
0065 #endif /* __cplusplus */
0066
0067 #endif /* _RTEMS_RECORDSERVER_H */