Frank Vannieuwkerke / cc3000_hostdriver_mbedsocket

cc3000 hostdriver with the mbed socket interface

Fork of cc3000_hostdriver_mbedsocket by Martin Kojtal

Socket/Endpoint.h@0:615c697c33b0, 2013-09-19 (annotated)

Committer:
Kojto
Date:
Thu Sep 19 07:55:14 2013 +0000
Revision:
0:615c697c33b0
Child:
5:245ac5b73132
initial commit

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Kojto 0:615c697c33b0 1 /* Copyright (C) 2012 mbed.org, MIT License
Kojto 0:615c697c33b0 2 *
Kojto 0:615c697c33b0 3 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
Kojto 0:615c697c33b0 4 * and associated documentation files (the "Software"), to deal in the Software without restriction,
Kojto 0:615c697c33b0 5 * including without limitation the rights to use, copy, modify, merge, publish, distribute,
Kojto 0:615c697c33b0 6 * sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
Kojto 0:615c697c33b0 7 * furnished to do so, subject to the following conditions:
Kojto 0:615c697c33b0 8 *
Kojto 0:615c697c33b0 9 * The above copyright notice and this permission notice shall be included in all copies or
Kojto 0:615c697c33b0 10 * substantial portions of the Software.
Kojto 0:615c697c33b0 11 *
Kojto 0:615c697c33b0 12 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
Kojto 0:615c697c33b0 13 * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
Kojto 0:615c697c33b0 14 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
Kojto 0:615c697c33b0 15 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
Kojto 0:615c697c33b0 16 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Kojto 0:615c697c33b0 17 */
Kojto 0:615c697c33b0 18 #ifndef ENDPOINT_H
Kojto 0:615c697c33b0 19 #define ENDPOINT_H
Kojto 0:615c697c33b0 20
Kojto 0:615c697c33b0 21 #include "cc3000.h"
Kojto 0:615c697c33b0 22
Kojto 0:615c697c33b0 23 using namespace mbed_cc3000;
Kojto 0:615c697c33b0 24
Kojto 0:615c697c33b0 25 class UDPSocket;
Kojto 0:615c697c33b0 26
Kojto 0:615c697c33b0 27 /**
Kojto 0:615c697c33b0 28 IP Endpoint (address, port)
Kojto 0:615c697c33b0 29 */
Kojto 0:615c697c33b0 30 class Endpoint {
Kojto 0:615c697c33b0 31 friend class UDPSocket;
Kojto 0:615c697c33b0 32
Kojto 0:615c697c33b0 33 public:
Kojto 0:615c697c33b0 34 /** IP Endpoint (address, port)
Kojto 0:615c697c33b0 35 */
Kojto 0:615c697c33b0 36 Endpoint(void);
Kojto 0:615c697c33b0 37
Kojto 0:615c697c33b0 38 ~Endpoint(void);
Kojto 0:615c697c33b0 39
Kojto 0:615c697c33b0 40 /** Reset the address of this endpoint
Kojto 0:615c697c33b0 41 */
Kojto 0:615c697c33b0 42 void reset_address(void);
Kojto 0:615c697c33b0 43
Kojto 0:615c697c33b0 44 /** Set the address of this endpoint
Kojto 0:615c697c33b0 45 \param host The endpoint address (it can either be an IP Address or a hostname that will be resolved with DNS).
Kojto 0:615c697c33b0 46 \param port The endpoint port
Kojto 0:615c697c33b0 47 \return 0 on success, -1 on failure (when an hostname cannot be resolved by DNS).
Kojto 0:615c697c33b0 48 */
Kojto 0:615c697c33b0 49 int set_address(const char* host, const int port);
Kojto 0:615c697c33b0 50
Kojto 0:615c697c33b0 51 /** Get the IP address of this endpoint
Kojto 0:615c697c33b0 52 \return The IP address of this endpoint.
Kojto 0:615c697c33b0 53 */
Kojto 0:615c697c33b0 54 char* get_address(void);
Kojto 0:615c697c33b0 55
Kojto 0:615c697c33b0 56 /** Get the port of this endpoint
Kojto 0:615c697c33b0 57 \return The port of this endpoint
Kojto 0:615c697c33b0 58 */
Kojto 0:615c697c33b0 59 int get_port(void);
Kojto 0:615c697c33b0 60
Kojto 0:615c697c33b0 61 protected:
Kojto 0:615c697c33b0 62 char _ipAddress[17];
Kojto 0:615c697c33b0 63 sockaddr_in _remote_host;
Kojto 0:615c697c33b0 64 cc3000 *_cc3000_module;
Kojto 0:615c697c33b0 65 };
Kojto 0:615c697c33b0 66
Kojto 0:615c697c33b0 67 #endif