pefect / NetworkSocketAPI

ap

Dependencies:   DnsQuery

Dependents:   WizFi310_TCP_Echo_Server_Example

Fork of NetworkSocketAPI by NetworkSocketAPI

UDPSocket.h@79:43a7e8c0d6cc, 2016-04-05 (annotated)

Committer:
Christopher Haster
Date:
Tue Apr 05 10:40:34 2016 -0500
Revision:
79:43a7e8c0d6cc
Parent:
78:0914f9b9b24b
Child:
80:9c6673c93082
Added rough implementation of the API shim

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