taiyou komazawa / Mbed 2 deprecated Nucleo_F746ZG_Ethernet

mbed-cliのインポート用

Dependencies:   F7_Ethernet mbed

Fork of Nucleo_F746ZG_Ethernet by Dieter Graef

F7_Ethernet/Socket/UDPSocket.h@0:f9b6112278fe, 2016-06-18 (annotated)

Committer:
DieterGraef
Date:
Sat Jun 18 10:49:12 2016 +0000
Revision:
0:f9b6112278fe
Ethernet for the NUCLEO STM32F746 Board Testprogram uses DHCP and NTP to set the clock

Who changed what in which revision?

UserRevisionLine numberNew contents of line
DieterGraef 0:f9b6112278fe 1 /* Copyright (C) 2012 mbed.org, MIT License
DieterGraef 0:f9b6112278fe 2 *
DieterGraef 0:f9b6112278fe 3 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
DieterGraef 0:f9b6112278fe 4 * and associated documentation files (the "Software"), to deal in the Software without restriction,
DieterGraef 0:f9b6112278fe 5 * including without limitation the rights to use, copy, modify, merge, publish, distribute,
DieterGraef 0:f9b6112278fe 6 * sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
DieterGraef 0:f9b6112278fe 7 * furnished to do so, subject to the following conditions:
DieterGraef 0:f9b6112278fe 8 *
DieterGraef 0:f9b6112278fe 9 * The above copyright notice and this permission notice shall be included in all copies or
DieterGraef 0:f9b6112278fe 10 * substantial portions of the Software.
DieterGraef 0:f9b6112278fe 11 *
DieterGraef 0:f9b6112278fe 12 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
DieterGraef 0:f9b6112278fe 13 * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
DieterGraef 0:f9b6112278fe 14 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
DieterGraef 0:f9b6112278fe 15 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
DieterGraef 0:f9b6112278fe 16 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
DieterGraef 0:f9b6112278fe 17 */
DieterGraef 0:f9b6112278fe 18
DieterGraef 0:f9b6112278fe 19 #ifndef UDPSOCKET_H
DieterGraef 0:f9b6112278fe 20 #define UDPSOCKET_H
DieterGraef 0:f9b6112278fe 21
DieterGraef 0:f9b6112278fe 22 #include "Socket/Socket.h"
DieterGraef 0:f9b6112278fe 23 #include "Socket/Endpoint.h"
DieterGraef 0:f9b6112278fe 24
DieterGraef 0:f9b6112278fe 25 /**
DieterGraef 0:f9b6112278fe 26 UDP Socket
DieterGraef 0:f9b6112278fe 27 */
DieterGraef 0:f9b6112278fe 28 class UDPSocket : public Socket {
DieterGraef 0:f9b6112278fe 29
DieterGraef 0:f9b6112278fe 30 public:
DieterGraef 0:f9b6112278fe 31 /** Instantiate an UDP Socket.
DieterGraef 0:f9b6112278fe 32 */
DieterGraef 0:f9b6112278fe 33 UDPSocket();
DieterGraef 0:f9b6112278fe 34
DieterGraef 0:f9b6112278fe 35 /** Init the UDP Client Socket without binding it to any specific port
DieterGraef 0:f9b6112278fe 36 \return 0 on success, -1 on failure.
DieterGraef 0:f9b6112278fe 37 */
DieterGraef 0:f9b6112278fe 38 int init(void);
DieterGraef 0:f9b6112278fe 39
DieterGraef 0:f9b6112278fe 40 /** Bind a UDP Server Socket to a specific port
DieterGraef 0:f9b6112278fe 41 \param port The port to listen for incoming connections on
DieterGraef 0:f9b6112278fe 42 \return 0 on success, -1 on failure.
DieterGraef 0:f9b6112278fe 43 */
DieterGraef 0:f9b6112278fe 44 int bind(int port);
DieterGraef 0:f9b6112278fe 45
DieterGraef 0:f9b6112278fe 46 /** Join the multicast group at the given address
DieterGraef 0:f9b6112278fe 47 \param address The address of the multicast group
DieterGraef 0:f9b6112278fe 48 \return 0 on success, -1 on failure.
DieterGraef 0:f9b6112278fe 49 */
DieterGraef 0:f9b6112278fe 50 int join_multicast_group(const char* address);
DieterGraef 0:f9b6112278fe 51
DieterGraef 0:f9b6112278fe 52 /** Set the socket in broadcasting mode
DieterGraef 0:f9b6112278fe 53 \return 0 on success, -1 on failure.
DieterGraef 0:f9b6112278fe 54 */
DieterGraef 0:f9b6112278fe 55 int set_broadcasting(bool broadcast=true);
DieterGraef 0:f9b6112278fe 56
DieterGraef 0:f9b6112278fe 57 /** Send a packet to a remote endpoint
DieterGraef 0:f9b6112278fe 58 \param remote The remote endpoint
DieterGraef 0:f9b6112278fe 59 \param packet The packet to be sent
DieterGraef 0:f9b6112278fe 60 \param length The length of the packet to be sent
DieterGraef 0:f9b6112278fe 61 \return the number of written bytes on success (>=0) or -1 on failure
DieterGraef 0:f9b6112278fe 62 */
DieterGraef 0:f9b6112278fe 63 int sendTo(Endpoint &remote, char *packet, int length);
DieterGraef 0:f9b6112278fe 64
DieterGraef 0:f9b6112278fe 65 /** Receive a packet from a remote endpoint
DieterGraef 0:f9b6112278fe 66 \param remote The remote endpoint
DieterGraef 0:f9b6112278fe 67 \param buffer The buffer for storing the incoming packet data. If a packet
DieterGraef 0:f9b6112278fe 68 is too long to fit in the supplied buffer, excess bytes are discarded
DieterGraef 0:f9b6112278fe 69 \param length The length of the buffer
DieterGraef 0:f9b6112278fe 70 \return the number of received bytes on success (>=0) or -1 on failure
DieterGraef 0:f9b6112278fe 71 */
DieterGraef 0:f9b6112278fe 72 int receiveFrom(Endpoint &remote, char *buffer, int length);
DieterGraef 0:f9b6112278fe 73 };
DieterGraef 0:f9b6112278fe 74
DieterGraef 0:f9b6112278fe 75 #endif