mirror of https://github.com/ARMmbed/mbed-os.git
67 lines
2.4 KiB
C++
67 lines
2.4 KiB
C++
/* Socket
|
|
* Copyright (c) 2015 ARM Limited
|
|
*
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
* you may not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*/
|
|
|
|
#ifndef UDPSOCKET_H
|
|
#define UDPSOCKET_H
|
|
|
|
#include "Socket.h"
|
|
#include "NetworkInterface.h"
|
|
|
|
/** UDP Socket
|
|
*/
|
|
class UDPSocket : public Socket {
|
|
public:
|
|
/** UDPSocket lifetime
|
|
*/
|
|
UDPSocket();
|
|
UDPSocket(NetworkInterface *iface);
|
|
|
|
/** Open the socket
|
|
* @param iface Interface to open socket on
|
|
*/
|
|
virtual int open(NetworkInterface *iface);
|
|
|
|
/** Send a packet to a remote endpoint
|
|
* @param host The host to connect to. It can either be an IP Address
|
|
* or a hostname that will be resolved with DNS
|
|
* @param port The remote port
|
|
* @param data The packet to be sent
|
|
* @param size The length of the packet to be sent
|
|
* @return The number of written bytes on success, negative on failure
|
|
*/
|
|
int sendto(const char *host, uint16_t port, const void *data, unsigned size);
|
|
|
|
/** Send a packet to a remote endpoint
|
|
* @param address The remote SocketAddress
|
|
* @param data The packet to be sent
|
|
* @param size The length of the packet to be sent
|
|
* @return The number of written bytes on success, negative on failure
|
|
*/
|
|
int sendto(const SocketAddress &address, const void *data, unsigned size);
|
|
|
|
/** Receive a packet from a remote endpoint
|
|
* @param address Destination for the remote SocketAddress or null
|
|
* @param buffer The buffer for storing the incoming packet data
|
|
* If a packet is too long to fit in the supplied buffer,
|
|
* excess bytes are discarded
|
|
* @param size The length of the buffer
|
|
* @return The number of received bytes on success, negative on failure
|
|
*/
|
|
int recvfrom(SocketAddress *address, void *buffer, unsigned size);
|
|
};
|
|
|
|
#endif
|