Multi-Hackers / SocketModem

A library for talking to Multi-Tech's Cellular SocketModem Devices.

Dependents:   M2X_dev axeda_wrapper_dev MTS_M2x_Example1 MTS_Cellular_Connect_Example ... more

Socket/Endpoint.h@29:7408b1bdad37, 2013-12-18 (annotated)

Committer:
mfiore
Date:
Wed Dec 18 16:04:57 2013 +0000
Revision:
29:7408b1bdad37
Parent:
20:6e7eaf4f8634 
add cellular->reset() function (may need to be changed to HW reset); fixed bug in Endpoint code; added correct handling of DCD and DTR lines to/from radio

Who changed what in which revision?

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