summaryrefslogtreecommitdiffstats
path: root/Src/Multiplexer/udp-stream.h
blob: df6c5dbf9c686a4003ea7d03f0100a4e9f0d643e (plain)
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
/*
 * Video On Demand Samples
 *
 * Copyright (C) 2015 Microchip Technology Germany II GmbH & Co. KG
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 * You may also obtain this software under a propriety license from Microchip.
 * Please contact Microchip for further information.
 *
 */

 /*----------------------------------------------------------*/
/*! \file
 *  \brief  This file contains the a simple C-API to send a UDP stream.
 */
/*----------------------------------------------------------*/
#ifndef UDP_STREAM_H
#define UDP_STREAM_H

#include <stdint.h>
#include <stdbool.h>


#ifdef __cplusplus
extern "C"
{
#endif

/*----------------------------------------------------------*/
/*! \brief Initializies the UDP socket.
 *  \note  Do not call any other function of this component, before calling this function.
 *  \param targetIp - IP address of remote node as zero terminated string.
 *  \param targetPort - Port number of remote node.
 *  \return True, if successful, false otherwise.
 */
/*----------------------------------------------------------*/
bool UdpStream_Init( const char *targetIp, int targetPort );

/*----------------------------------------------------------*/
/*! \brief Deinitializies the UDP socket.
 *  \note  Do not call any other function of this component, after calling this function.
 */
/*----------------------------------------------------------*/
void UdpStream_Close();

/*----------------------------------------------------------*/
/*! \brief Send the given Data via the UDP socket.
 *  \param data - Byte array to be sent.
 *  \param length - The length of the Byte array.
 *  \return True, if successful, false otherwise.
 */
/*----------------------------------------------------------*/
bool UdpStream_Send( const uint8_t *data, uint32_t length );

#ifdef __cplusplus
}
#endif

#endif //UDP_STREAM_H