pefect / NetworkSocketAPI

ap

Dependencies:   DnsQuery

Dependents:   WizFi310_TCP_Echo_Server_Example

Fork of NetworkSocketAPI by NetworkSocketAPI

UDPSocket.h@96:656011e49d9f, 2016-04-19 (annotated)

Committer:
Christopher Haster
Date:
Tue Apr 19 18:24:34 2016 -0500
Revision:
96:656011e49d9f
Parent:
92:dd5f19874adf
Child:
98:0f614f1d0398
Added better support for SocketAddress/string addresses/ports

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Christopher Haster 78:0914f9b9b24b 1 /* Socket
Christopher Haster 78:0914f9b9b24b 2 * Copyright (c) 2015 ARM Limited
Christopher Haster 72:6a8b52ee83ed 3 *
Christopher Haster 78:0914f9b9b24b 4 * Licensed under the Apache License, Version 2.0 (the "License");
Christopher Haster 78:0914f9b9b24b 5 * you may not use this file except in compliance with the License.
Christopher Haster 78:0914f9b9b24b 6 * You may obtain a copy of the License at
Christopher Haster 72:6a8b52ee83ed 7 *
Christopher Haster 78:0914f9b9b24b 8 * http://www.apache.org/licenses/LICENSE-2.0
Christopher Haster 72:6a8b52ee83ed 9 *
Christopher Haster 78:0914f9b9b24b 10 * Unless required by applicable law or agreed to in writing, software
Christopher Haster 78:0914f9b9b24b 11 * distributed under the License is distributed on an "AS IS" BASIS,
Christopher Haster 78:0914f9b9b24b 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
Christopher Haster 78:0914f9b9b24b 13 * See the License for the specific language governing permissions and
Christopher Haster 78:0914f9b9b24b 14 * limitations under the License.
Christopher Haster 72:6a8b52ee83ed 15 */
Christopher Haster 72:6a8b52ee83ed 16
Christopher Haster 72:6a8b52ee83ed 17 #ifndef UDPSOCKET_H
Christopher Haster 72:6a8b52ee83ed 18 #define UDPSOCKET_H
Christopher Haster 72:6a8b52ee83ed 19
Christopher Haster 72:6a8b52ee83ed 20 #include "Socket.h"
Christopher Haster 77:b66a6984ed2d 21 #include "NetworkInterface.h"
Christopher Haster 72:6a8b52ee83ed 22
Christopher Haster 89:b1d417383c0d 23 /** UDP Socket
Christopher Haster 89:b1d417383c0d 24 */
Christopher Haster 72:6a8b52ee83ed 25 class UDPSocket : public Socket {
Christopher Haster 72:6a8b52ee83ed 26 public:
Christopher Haster 72:6a8b52ee83ed 27 /** UDPSocket lifetime
Christopher Haster 89:b1d417383c0d 28 */
Christopher Haster 90:0a988e4abb72 29 UDPSocket();
Christopher Haster 77:b66a6984ed2d 30 UDPSocket(NetworkInterface *iface);
Christopher Haster 90:0a988e4abb72 31
Christopher Haster 90:0a988e4abb72 32 /** Open the socket
Christopher Haster 90:0a988e4abb72 33 * @param iface Interface to open socket on
Christopher Haster 90:0a988e4abb72 34 */
Christopher Haster 90:0a988e4abb72 35 virtual int open(NetworkInterface *iface);
Christopher Haster 72:6a8b52ee83ed 36
Christopher Haster 72:6a8b52ee83ed 37 /** Bind a UDP Server Socket to a specific port
Christopher Haster 89:b1d417383c0d 38 * @param port The port to listen for incoming connections on
Christopher Haster 89:b1d417383c0d 39 * @return 0 on success, negative on failure.
Christopher Haster 89:b1d417383c0d 40 */
Christopher Haster 79:43a7e8c0d6cc 41 int bind(uint16_t port);
Christopher Haster 75:dea0cdb42241 42
Christopher Haster 96:656011e49d9f 43 /** Bind a UDP Server Socket to a local address
Christopher Haster 96:656011e49d9f 44 * @param address The null-terminated address to listen for incoming connections on
Christopher Haster 96:656011e49d9f 45 * @param port The port to listen for incoming connections on
Christopher Haster 96:656011e49d9f 46 * @return 0 on success, negative on failure.
Christopher Haster 96:656011e49d9f 47 */
Christopher Haster 96:656011e49d9f 48 int bind(const char *address, uint16_t port);
Christopher Haster 96:656011e49d9f 49
Christopher Haster 96:656011e49d9f 50 /** Bind a UDP Server Socket to a local address
Christopher Haster 96:656011e49d9f 51 * @param address The SocketAddress to listen for incoming connections on
Christopher Haster 96:656011e49d9f 52 * @return 0 on success, negative on failure.
Christopher Haster 96:656011e49d9f 53 */
Christopher Haster 96:656011e49d9f 54 int bind(const SocketAddress &address);
Christopher Haster 96:656011e49d9f 55
Christopher Haster 96:656011e49d9f 56 /** Send a packet to a remote endpoint
Christopher Haster 96:656011e49d9f 57 * @param host The host to connect to. It can either be an IP Address
Christopher Haster 96:656011e49d9f 58 * or a hostname that will be resolved with DNS
Christopher Haster 96:656011e49d9f 59 * @param port The remote port
Christopher Haster 96:656011e49d9f 60 * @param data The packet to be sent
Christopher Haster 96:656011e49d9f 61 * @param size The length of the packet to be sent
Christopher Haster 96:656011e49d9f 62 * @return The number of written bytes on success, negative on failure
Christopher Haster 96:656011e49d9f 63 */
Christopher Haster 96:656011e49d9f 64 int sendto(const char *host, uint16_t port, const void *data, unsigned size);
Christopher Haster 96:656011e49d9f 65
Christopher Haster 72:6a8b52ee83ed 66 /** Send a packet to a remote endpoint
Christopher Haster 89:b1d417383c0d 67 * @param address The remote SocketAddress
Christopher Haster 89:b1d417383c0d 68 * @param data The packet to be sent
Christopher Haster 89:b1d417383c0d 69 * @param size The length of the packet to be sent
Christopher Haster 89:b1d417383c0d 70 * @return The number of written bytes on success, negative on failure
Christopher Haster 89:b1d417383c0d 71 */
Christopher Haster 80:9c6673c93082 72 int sendto(const SocketAddress &address, const void *data, unsigned size);
Christopher Haster 75:dea0cdb42241 73
Christopher Haster 72:6a8b52ee83ed 74 /** Receive a packet from a remote endpoint
Christopher Haster 89:b1d417383c0d 75 * @param address Destination for the remote SocketAddress or null
Christopher Haster 89:b1d417383c0d 76 * @param buffer The buffer for storing the incoming packet data
Christopher Haster 89:b1d417383c0d 77 * If a packet is too long to fit in the supplied buffer,
Christopher Haster 89:b1d417383c0d 78 * excess bytes are discarded
Christopher Haster 89:b1d417383c0d 79 * @param size The length of the buffer
Christopher Haster 89:b1d417383c0d 80 * @return The number of received bytes on success, negative on failure
Christopher Haster 89:b1d417383c0d 81 */
Christopher Haster 75:dea0cdb42241 82 int recvfrom(SocketAddress *address, void *buffer, unsigned size);
Christopher Haster 72:6a8b52ee83ed 83 };
Christopher Haster 72:6a8b52ee83ed 84
Christopher Haster 72:6a8b52ee83ed 85 #endif