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

Embed: (wiki syntax)

« Back to documentation index

Transport Class Reference
Public Types | Static Public Member Functions

Transport Class Reference

This class has been added to the standard mbed Socket library enabling people to use the Socket library interfaces for different transports that have their own internal IP-Stack. More...

#include <Transport.h>

Public Types

enum  TransportType
 

An enumeration that holds the supported Transport Types.

More...

Static Public Member Functions

static void setTransport (TransportType type)
 This method allows you to set the transport to be used when creating other objects from the Socket folder like TCPSocketConnection and UDPSocket.
static void setTransport (IPStack *type)
 This method allows you to set the transport to be used when creatin other objects from the Socket folder like TCPSocketConnection and UDPSocket.
static IPStack * getInstance ()
 This method is used within the Socket class to get the appropraite transport as an IPStack object.

Detailed Description

This class has been added to the standard mbed Socket library enabling people to use the Socket library interfaces for different transports that have their own internal IP-Stack.

Use this class prior to instantiating any of the other classes in this folder to determine the underlying transport that will be used by them. It is important to know that the transport classes themsleves like Cellular or WiFi, must be properly initialized and connected before any of the Socket package classes can be used or even instantiated.

Definition at line 33 of file Transport.h.

Member Enumeration Documentation

enum TransportType

An enumeration that holds the supported Transport Types.

Definition at line 37 of file Transport.h.

Member Function Documentation

IPStack * getInstance (  ) [static]

This method is used within the Socket class to get the appropraite transport as an IPStack object.

In general you do not need to call this directly, but simply use the other classes in this folder.

Returns:
a pointer to an object that implements IPStack.

Definition at line 40 of file Transport.cpp.

void setTransport ( TransportType  type ) [static]

This method allows you to set the transport to be used when creating other objects from the Socket folder like TCPSocketConnection and UDPSocket.

Parameters:
typethe type of underlying transport to be used. The default is NONE.

Definition at line 25 of file Transport.cpp.

static void setTransport ( IPStack *  type ) [static]

This method allows you to set the transport to be used when creatin other objects from the Socket folder like TCPSocketConnection and UDPSocket.

It differs from the other setTransport method in that it allows for any transport that derives from IPStack to be used with the native mbed Socket interfaces.

Parameters:
typethe type of underlying transport to be used as an IPStack object.
Generated on Tue Jul 12 2022 21:46:23 by  doxygen 1.7.2