Socket::close() now supports an additional parameter for defining the shutdown type
Fork of Socket by
UDPSocket.h@2:b227d242f3c7, 2012-07-23 (annotated)
- Committer:
- emilmont
- Date:
- Mon Jul 23 11:52:50 2012 +0000
- Revision:
- 2:b227d242f3c7
- Parent:
- 1:8080965f5d76
- Child:
- 3:e6474399e057
tidyup
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
donatien | 0:1f77255a22f5 | 1 | /* Copyright (C) 2012 mbed.org, MIT License |
donatien | 0:1f77255a22f5 | 2 | * |
donatien | 0:1f77255a22f5 | 3 | * Permission is hereby granted, free of charge, to any person obtaining a copy of this software |
donatien | 0:1f77255a22f5 | 4 | * and associated documentation files (the "Software"), to deal in the Software without restriction, |
donatien | 0:1f77255a22f5 | 5 | * including without limitation the rights to use, copy, modify, merge, publish, distribute, |
donatien | 0:1f77255a22f5 | 6 | * sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is |
donatien | 0:1f77255a22f5 | 7 | * furnished to do so, subject to the following conditions: |
donatien | 0:1f77255a22f5 | 8 | * |
donatien | 0:1f77255a22f5 | 9 | * The above copyright notice and this permission notice shall be included in all copies or |
donatien | 0:1f77255a22f5 | 10 | * substantial portions of the Software. |
donatien | 0:1f77255a22f5 | 11 | * |
donatien | 0:1f77255a22f5 | 12 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING |
donatien | 0:1f77255a22f5 | 13 | * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND |
donatien | 0:1f77255a22f5 | 14 | * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, |
donatien | 0:1f77255a22f5 | 15 | * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
donatien | 0:1f77255a22f5 | 16 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
donatien | 0:1f77255a22f5 | 17 | */ |
donatien | 0:1f77255a22f5 | 18 | |
donatien | 0:1f77255a22f5 | 19 | #ifndef UDPSOCKET_H |
donatien | 0:1f77255a22f5 | 20 | #define UDPSOCKET_H |
donatien | 0:1f77255a22f5 | 21 | |
emilmont | 2:b227d242f3c7 | 22 | #include "Socket/socket.h" |
donatien | 0:1f77255a22f5 | 23 | #include <cstdint> |
donatien | 0:1f77255a22f5 | 24 | |
donatien | 0:1f77255a22f5 | 25 | /** |
donatien | 0:1f77255a22f5 | 26 | This is a C++ abstraction for UDP networking sockets. |
donatien | 0:1f77255a22f5 | 27 | */ |
donatien | 0:1f77255a22f5 | 28 | class UDPSocket |
donatien | 0:1f77255a22f5 | 29 | { |
donatien | 0:1f77255a22f5 | 30 | public: |
donatien | 0:1f77255a22f5 | 31 | |
donatien | 0:1f77255a22f5 | 32 | /** Instantiate a UDP Socket. |
donatien | 0:1f77255a22f5 | 33 | */ |
donatien | 0:1f77255a22f5 | 34 | UDPSocket(); |
donatien | 0:1f77255a22f5 | 35 | |
donatien | 0:1f77255a22f5 | 36 | ~UDPSocket(); |
donatien | 0:1f77255a22f5 | 37 | |
donatien | 0:1f77255a22f5 | 38 | /** Bind a socket to a specific port. |
donatien | 0:1f77255a22f5 | 39 | For a listening socket, bind the socket to the following port. |
donatien | 0:1f77255a22f5 | 40 | \param port The port to listen for incoming connections on, using 0 here will select a random port. |
donatien | 0:1f77255a22f5 | 41 | \return 0 on success, -1 on failure. |
donatien | 0:1f77255a22f5 | 42 | */ |
donatien | 0:1f77255a22f5 | 43 | int bind(int port); |
donatien | 0:1f77255a22f5 | 44 | |
donatien | 0:1f77255a22f5 | 45 | /** Send data to a remote host. |
donatien | 0:1f77255a22f5 | 46 | \param data The buffer to send to the host. |
donatien | 0:1f77255a22f5 | 47 | \param length The length of the buffer to send. |
donatien | 0:1f77255a22f5 | 48 | \param host The host to send data to. It can either be an IP Address or a hostname that will be resolved with DNS. |
donatien | 0:1f77255a22f5 | 49 | \param port The host's port to send data to. |
donatien | 0:1f77255a22f5 | 50 | \param timeout The maximum amount of time in ms to wait while trying to send the buffer. |
donatien | 0:1f77255a22f5 | 51 | \return the number of written bytes on success (>=0) or -1 on failure |
donatien | 0:1f77255a22f5 | 52 | */ |
donatien | 1:8080965f5d76 | 53 | int sendTo(char* data, int length, char* host, int port, int timeout = 0); |
donatien | 0:1f77255a22f5 | 54 | |
donatien | 0:1f77255a22f5 | 55 | /** Receive data from a remote host. |
donatien | 0:1f77255a22f5 | 56 | \param data The buffer in which to store the data received from the host. |
donatien | 0:1f77255a22f5 | 57 | \param length The maximum length of the buffer. |
donatien | 0:1f77255a22f5 | 58 | \param host The reference that will point to the client's IP address. |
donatien | 0:1f77255a22f5 | 59 | \param port The reference that will point to the client's port. |
donatien | 0:1f77255a22f5 | 60 | \param timeout The maximum amount of time in ms to wait while trying to receive data. |
donatien | 0:1f77255a22f5 | 61 | \return the number of received bytes on success (>=0) or -1 on failure |
donatien | 0:1f77255a22f5 | 62 | */ |
donatien | 1:8080965f5d76 | 63 | int receiveFrom(char* data, int length, char** host, int* port, int timeout = 0); |
donatien | 0:1f77255a22f5 | 64 | |
donatien | 0:1f77255a22f5 | 65 | /** Close the socket. |
donatien | 0:1f77255a22f5 | 66 | */ |
donatien | 0:1f77255a22f5 | 67 | int close(); |
donatien | 0:1f77255a22f5 | 68 | |
donatien | 0:1f77255a22f5 | 69 | private: |
donatien | 0:1f77255a22f5 | 70 | int init(); |
donatien | 0:1f77255a22f5 | 71 | |
donatien | 0:1f77255a22f5 | 72 | int m_sock; |
donatien | 0:1f77255a22f5 | 73 | |
donatien | 0:1f77255a22f5 | 74 | }; |
donatien | 0:1f77255a22f5 | 75 | |
donatien | 0:1f77255a22f5 | 76 | #endif |