pefect / NetworkSocketAPI

ap

Dependencies:   DnsQuery

Dependents:   WizFi310_TCP_Echo_Server_Example

Fork of NetworkSocketAPI by NetworkSocketAPI

UDPSocket.h@89:b1d417383c0d, 2016-04-19 (annotated)

Committer:
Christopher Haster
Date:
Tue Apr 19 18:20:38 2016 -0500
Revision:
89:b1d417383c0d
Parent:
81:1600369a29dd
Child:
90:0a988e4abb72
Adopt mbed style doxygen comments

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 77:b66a6984ed2d 29 UDPSocket(NetworkInterface *iface);
Christopher Haster 81:1600369a29dd 30 virtual ~UDPSocket();
Christopher Haster 72:6a8b52ee83ed 31
Christopher Haster 72:6a8b52ee83ed 32 /** Bind a UDP Server Socket to a specific port
Christopher Haster 89:b1d417383c0d 33 * @param port The port to listen for incoming connections on
Christopher Haster 89:b1d417383c0d 34 * @return 0 on success, negative on failure.
Christopher Haster 89:b1d417383c0d 35 */
Christopher Haster 79:43a7e8c0d6cc 36 int bind(uint16_t port);
Christopher Haster 75:dea0cdb42241 37
Christopher Haster 72:6a8b52ee83ed 38 /** Send a packet to a remote endpoint
Christopher Haster 89:b1d417383c0d 39 * @param address The remote SocketAddress
Christopher Haster 89:b1d417383c0d 40 * @param data The packet to be sent
Christopher Haster 89:b1d417383c0d 41 * @param size The length of the packet to be sent
Christopher Haster 89:b1d417383c0d 42 * @return The number of written bytes on success, negative on failure
Christopher Haster 89:b1d417383c0d 43 */
Christopher Haster 80:9c6673c93082 44 int sendto(const SocketAddress &address, const void *data, unsigned size);
Christopher Haster 75:dea0cdb42241 45
Christopher Haster 72:6a8b52ee83ed 46 /** Receive a packet from a remote endpoint
Christopher Haster 89:b1d417383c0d 47 * @param address Destination for the remote SocketAddress or null
Christopher Haster 89:b1d417383c0d 48 * @param buffer The buffer for storing the incoming packet data
Christopher Haster 89:b1d417383c0d 49 * If a packet is too long to fit in the supplied buffer,
Christopher Haster 89:b1d417383c0d 50 * excess bytes are discarded
Christopher Haster 89:b1d417383c0d 51 * @param size The length of the buffer
Christopher Haster 89:b1d417383c0d 52 * @return The number of received bytes on success, negative on failure
Christopher Haster 89:b1d417383c0d 53 */
Christopher Haster 75:dea0cdb42241 54 int recvfrom(SocketAddress *address, void *buffer, unsigned size);
Christopher Haster 73:968f7b32278f 55
Christopher Haster 73:968f7b32278f 56 /** Register a callback on when send is ready
Christopher Haster 89:b1d417383c0d 57 * @param callback Function to call when send will succeed, may be called in
Christopher Haster 89:b1d417383c0d 58 * interrupt context.
Christopher Haster 89:b1d417383c0d 59 */
Christopher Haster 89:b1d417383c0d 60 void attach_send(FunctionPointer callback);
Christopher Haster 73:968f7b32278f 61
Christopher Haster 81:1600369a29dd 62 template <typename T, typename M>
Christopher Haster 81:1600369a29dd 63 void attach_send(T *tptr, M mptr) {
Christopher Haster 89:b1d417383c0d 64 attach_send(FunctionPointer(tptr, mptr));
Christopher Haster 81:1600369a29dd 65 }
Christopher Haster 81:1600369a29dd 66
Christopher Haster 73:968f7b32278f 67 /** Register a callback on when recv is ready
Christopher Haster 89:b1d417383c0d 68 * @param callback Function to call when recv will succeed, may be called in
Christopher Haster 89:b1d417383c0d 69 * interrupt context.
Christopher Haster 89:b1d417383c0d 70 */
Christopher Haster 89:b1d417383c0d 71 void attach_recv(FunctionPointer callback);
Christopher Haster 81:1600369a29dd 72
Christopher Haster 81:1600369a29dd 73 template <typename T, typename M>
Christopher Haster 81:1600369a29dd 74 void attach_recv(T *tptr, M mptr) {
Christopher Haster 89:b1d417383c0d 75 attach_recv(FunctionPointer(tptr, mptr));
Christopher Haster 81:1600369a29dd 76 }
Christopher Haster 81:1600369a29dd 77
Christopher Haster 81:1600369a29dd 78 private:
Christopher Haster 89:b1d417383c0d 79 FunctionPointer _send_cb;
Christopher Haster 89:b1d417383c0d 80 FunctionPointer _recv_cb;
Christopher Haster 72:6a8b52ee83ed 81 };
Christopher Haster 72:6a8b52ee83ed 82
Christopher Haster 72:6a8b52ee83ed 83 #endif