pefect / NetworkSocketAPI

ap

Dependencies:   DnsQuery

Dependents:   WizFi310_TCP_Echo_Server_Example

Fork of NetworkSocketAPI by NetworkSocketAPI

UDPSocket.h@90:0a988e4abb72, 2016-04-19 (annotated)

Committer:
Christopher Haster
Date:
Tue Apr 19 18:22:15 2016 -0500
Revision:
90:0a988e4abb72
Parent:
89:b1d417383c0d
Child:
92:dd5f19874adf
Add open call as alternative to passing NetworkInterface at construction



Pros

- Allows memory to be statically allocated

- Avoids issues with Thread creation before entering main

- Matches existing APIs such as FunctionPointer and Ticker



Cons

- Does not enforce passing a NetworkInterface

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