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

Diff: io/IPStack.h

Revision:
139:73a7d1cd2e9c
Parent:
46:b30547bf07d5
Child:
141:571e0ef6c8dc
--- a/io/IPStack.h	Sat Jan 04 00:55:16 2014 +0000
+++ b/io/IPStack.h	Sat Jan 04 04:22:29 2014 +0000
@@ -50,12 +50,14 @@
 
     /** This method is used to open a socket connection with the given parameters.
     * This socket connection is established using the devices built in IP stack.
+    * Currently TCP is the only supported mode.
     *
     * @param address is the address you want to connect to in the form of xxx.xxx.xxx.xxx
     * or a URL. If using a URL make sure the device supports DNS and is properly configured
     * for that mode.
     * @param port the remote port you want to connect to.
     * @param mode an enum that specifies whether this socket connection is type TCP or UDP.
+    * Currently only TCP is supported.
     * @returns true if the connection was successfully opened, otherwise false.
     */
     virtual bool open(const std::string& address, unsigned int port, Mode mode) = 0;