ON Semiconductor / mbed-os

Dependents:   mbed-TFT-example-NCS36510 mbed-Accelerometer-example-NCS36510 mbed-Accelerometer-example-NCS36510

features/netsocket/UDPSocket.h@1:f30bdcd2b33b, 2017-02-27 (annotated)

Committer:
jacobjohnson
Date:
Mon Feb 27 17:45:05 2017 +0000
Revision:
1:f30bdcd2b33b
Parent:
0:098463de4c5d 
changed the inputscale from 1 to 7 in analogin_api.c.  This will need to be changed later, and accessed from the main level, but for now this allows the  adc to read a value from 0 to 3.7V, instead of just up to 1V.;

Who changed what in which revision?

UserRevisionLine numberNew contents of line
group-onsemi 0:098463de4c5d 1
group-onsemi 0:098463de4c5d 2 /** \addtogroup netsocket */
group-onsemi 0:098463de4c5d 3 /** @{*/
group-onsemi 0:098463de4c5d 4 /* UDPSocket
group-onsemi 0:098463de4c5d 5 * Copyright (c) 2015 ARM Limited
group-onsemi 0:098463de4c5d 6 *
group-onsemi 0:098463de4c5d 7 * Licensed under the Apache License, Version 2.0 (the "License");
group-onsemi 0:098463de4c5d 8 * you may not use this file except in compliance with the License.
group-onsemi 0:098463de4c5d 9 * You may obtain a copy of the License at
group-onsemi 0:098463de4c5d 10 *
group-onsemi 0:098463de4c5d 11 * http://www.apache.org/licenses/LICENSE-2.0
group-onsemi 0:098463de4c5d 12 *
group-onsemi 0:098463de4c5d 13 * Unless required by applicable law or agreed to in writing, software
group-onsemi 0:098463de4c5d 14 * distributed under the License is distributed on an "AS IS" BASIS,
group-onsemi 0:098463de4c5d 15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
group-onsemi 0:098463de4c5d 16 * See the License for the specific language governing permissions and
group-onsemi 0:098463de4c5d 17 * limitations under the License.
group-onsemi 0:098463de4c5d 18 */
group-onsemi 0:098463de4c5d 19
group-onsemi 0:098463de4c5d 20 #ifndef UDPSOCKET_H
group-onsemi 0:098463de4c5d 21 #define UDPSOCKET_H
group-onsemi 0:098463de4c5d 22
group-onsemi 0:098463de4c5d 23 #include "netsocket/Socket.h"
group-onsemi 0:098463de4c5d 24 #include "netsocket/NetworkStack.h"
group-onsemi 0:098463de4c5d 25 #include "netsocket/NetworkInterface.h"
group-onsemi 0:098463de4c5d 26 #include "rtos/Semaphore.h"
group-onsemi 0:098463de4c5d 27
group-onsemi 0:098463de4c5d 28
group-onsemi 0:098463de4c5d 29 /** UDP socket
group-onsemi 0:098463de4c5d 30 */
group-onsemi 0:098463de4c5d 31 class UDPSocket : public Socket {
group-onsemi 0:098463de4c5d 32 public:
group-onsemi 0:098463de4c5d 33 /** Create an uninitialized socket
group-onsemi 0:098463de4c5d 34 *
group-onsemi 0:098463de4c5d 35 * Must call open to initialize the socket on a network stack.
group-onsemi 0:098463de4c5d 36 */
group-onsemi 0:098463de4c5d 37 UDPSocket();
group-onsemi 0:098463de4c5d 38
group-onsemi 0:098463de4c5d 39 /** Create a socket on a network interface
group-onsemi 0:098463de4c5d 40 *
group-onsemi 0:098463de4c5d 41 * Creates and opens a socket on the network stack of the given
group-onsemi 0:098463de4c5d 42 * network interface.
group-onsemi 0:098463de4c5d 43 *
group-onsemi 0:098463de4c5d 44 * @param stack Network stack as target for socket
group-onsemi 0:098463de4c5d 45 */
group-onsemi 0:098463de4c5d 46 template <typename S>
group-onsemi 0:098463de4c5d 47 UDPSocket(S *stack)
group-onsemi 0:098463de4c5d 48 : _pending(1), _read_sem(0), _write_sem(0)
group-onsemi 0:098463de4c5d 49 {
group-onsemi 0:098463de4c5d 50 open(stack);
group-onsemi 0:098463de4c5d 51 }
group-onsemi 0:098463de4c5d 52
group-onsemi 0:098463de4c5d 53 /** Destroy a socket
group-onsemi 0:098463de4c5d 54 *
group-onsemi 0:098463de4c5d 55 * Closes socket if the socket is still open
group-onsemi 0:098463de4c5d 56 */
group-onsemi 0:098463de4c5d 57 virtual ~UDPSocket();
group-onsemi 0:098463de4c5d 58
group-onsemi 0:098463de4c5d 59 /** Send a packet over a UDP socket
group-onsemi 0:098463de4c5d 60 *
group-onsemi 0:098463de4c5d 61 * Sends data to the specified address specified by either a domain name
group-onsemi 0:098463de4c5d 62 * or an IP address and port. Returns the number of bytes sent from the
group-onsemi 0:098463de4c5d 63 * buffer.
group-onsemi 0:098463de4c5d 64 *
group-onsemi 0:098463de4c5d 65 * By default, sendto blocks until data is sent. If socket is set to
group-onsemi 0:098463de4c5d 66 * non-blocking or times out, NSAPI_ERROR_WOULD_BLOCK is returned
group-onsemi 0:098463de4c5d 67 * immediately.
group-onsemi 0:098463de4c5d 68 *
group-onsemi 0:098463de4c5d 69 * @param host Hostname of the remote host
group-onsemi 0:098463de4c5d 70 * @param port Port of the remote host
group-onsemi 0:098463de4c5d 71 * @param data Buffer of data to send to the host
group-onsemi 0:098463de4c5d 72 * @param size Size of the buffer in bytes
group-onsemi 0:098463de4c5d 73 * @return Number of sent bytes on success, negative error
group-onsemi 0:098463de4c5d 74 * code on failure
group-onsemi 0:098463de4c5d 75 */
group-onsemi 0:098463de4c5d 76 nsapi_size_or_error_t sendto(const char *host, uint16_t port,
group-onsemi 0:098463de4c5d 77 const void *data, nsapi_size_t size);
group-onsemi 0:098463de4c5d 78
group-onsemi 0:098463de4c5d 79 /** Send a packet over a UDP socket
group-onsemi 0:098463de4c5d 80 *
group-onsemi 0:098463de4c5d 81 * Sends data to the specified address. Returns the number of bytes
group-onsemi 0:098463de4c5d 82 * sent from the buffer.
group-onsemi 0:098463de4c5d 83 *
group-onsemi 0:098463de4c5d 84 * By default, sendto blocks until data is sent. If socket is set to
group-onsemi 0:098463de4c5d 85 * non-blocking or times out, NSAPI_ERROR_WOULD_BLOCK is returned
group-onsemi 0:098463de4c5d 86 * immediately.
group-onsemi 0:098463de4c5d 87 *
group-onsemi 0:098463de4c5d 88 * @param address The SocketAddress of the remote host
group-onsemi 0:098463de4c5d 89 * @param data Buffer of data to send to the host
group-onsemi 0:098463de4c5d 90 * @param size Size of the buffer in bytes
group-onsemi 0:098463de4c5d 91 * @return Number of sent bytes on success, negative error
group-onsemi 0:098463de4c5d 92 * code on failure
group-onsemi 0:098463de4c5d 93 */
group-onsemi 0:098463de4c5d 94 nsapi_size_or_error_t sendto(const SocketAddress &address,
group-onsemi 0:098463de4c5d 95 const void *data, nsapi_size_t size);
group-onsemi 0:098463de4c5d 96
group-onsemi 0:098463de4c5d 97 /** Receive a packet over a UDP socket
group-onsemi 0:098463de4c5d 98 *
group-onsemi 0:098463de4c5d 99 * Receives data and stores the source address in address if address
group-onsemi 0:098463de4c5d 100 * is not NULL. Returns the number of bytes received into the buffer.
group-onsemi 0:098463de4c5d 101 *
group-onsemi 0:098463de4c5d 102 * By default, recvfrom blocks until data is sent. If socket is set to
group-onsemi 0:098463de4c5d 103 * non-blocking or times out, NSAPI_ERROR_WOULD_BLOCK is returned
group-onsemi 0:098463de4c5d 104 * immediately.
group-onsemi 0:098463de4c5d 105 *
group-onsemi 0:098463de4c5d 106 * @param address Destination for the source address or NULL
group-onsemi 0:098463de4c5d 107 * @param data Destination buffer for data received from the host
group-onsemi 0:098463de4c5d 108 * @param size Size of the buffer in bytes
group-onsemi 0:098463de4c5d 109 * @return Number of received bytes on success, negative error
group-onsemi 0:098463de4c5d 110 * code on failure
group-onsemi 0:098463de4c5d 111 */
group-onsemi 0:098463de4c5d 112 nsapi_size_or_error_t recvfrom(SocketAddress *address,
group-onsemi 0:098463de4c5d 113 void *data, nsapi_size_t size);
group-onsemi 0:098463de4c5d 114
group-onsemi 0:098463de4c5d 115 protected:
group-onsemi 0:098463de4c5d 116 virtual nsapi_protocol_t get_proto();
group-onsemi 0:098463de4c5d 117 virtual void event();
group-onsemi 0:098463de4c5d 118
group-onsemi 0:098463de4c5d 119 volatile unsigned _pending;
group-onsemi 0:098463de4c5d 120 rtos::Semaphore _read_sem;
group-onsemi 0:098463de4c5d 121 rtos::Semaphore _write_sem;
group-onsemi 0:098463de4c5d 122 };
group-onsemi 0:098463de4c5d 123
group-onsemi 0:098463de4c5d 124
group-onsemi 0:098463de4c5d 125 #endif
group-onsemi 0:098463de4c5d 126
group-onsemi 0:098463de4c5d 127 /** @}*/