Transport.h

00001 #ifndef TRANSPORT_H
00002 #define TRANSPORT_H
00003 
00004 #include "IPStack.h"
00005 
00006 /** This class has been added to the standard mbed Socket library enabling people
00007 * to use the Socket library interfaces for different transports. Use this class prior
00008 * to instantiating any of the other classes in this folder to determine the underlying
00009 * transport that will be used by them. It is important to know that the transport classes
00010 * themsleves which derive from IPStack.h, must be properly initialized and connected before any
00011 * of the Socket package classes can be used.
00012 */
00013 class Transport
00014 {
00015 public:        
00016     /** This method allows you to set the transport to be used when creatin other
00017     * objects from the Socket folder like TCPSocketConnection and UDPSocket.
00018     *
00019     * @param type the type of underlying transport to be used as an IPStack object.
00020     */
00021     static void setTransport(IPStack* type);
00022     
00023     /** This method is used within the Socket class to get the appropraite transport
00024     * as an IPStack object.  In general you do not need to call this directly, but
00025     * simply use the other classes in this folder. 
00026     *
00027     * @returns a pointer to an object that implements IPStack.
00028     */
00029     static IPStack* getInstance();
00030     
00031 private:
00032     static IPStack* transport; //Member variable that holds an custom transport type.
00033 };
00034 
00035 #endif /* TRANSPORT_H */