vos/metaobjects/misc/gateway.hh

Go to the documentation of this file.

/* $Id: gateway.hh,v 1.2 2003/07/22 05:08:42 tetron Exp $ */


/** @file gateway.hh Defines MetaObject class for "misc:gateway" object type (revision 0). */

/* This file was generated by otd2cpp.pl, a script for VOS by Reed Hedges
 * <reed@zerohour.net> and Peter Amstutz <tetron@interreality.org>
 *
 * Search for TODO for stuff that needs editing. You will want to especially fill
 * in constructors, destructors, message handlers, non-property subobjects...
 *
 * The authors of otd2cpp make no guarantee that this code will work, or even
 * that it even is safe to run.  Use it at your own risk.
 */

#ifndef _MISC_GATEWAY_HH_
#define _MISC_GATEWAY_HH_


#include <vos/corelibs/vos/vos.hh>
#include <vos/metaobjects/property/property.hh>


/** MetaObject implementing Gateway Object Type.

    Protocol for setting up port forwards for VOS sessions through a NAT gateway.

*/

class Gateway : public virtual MetaObject {

protected:
    PropertyAccessControl* accessControl;


public:

    /** Constructor */
    Gateway(MetaObject* superobject);

    /** Destructor */
    virtual ~Gateway();

    /** Return type string ("misc:gateway") */
    virtual const string getType();

    /** Register Extenders */
    static void registerExtenders();

    /** Set default access control policy */
    virtual void setPropertyAccessControl(PropertyAccessControl* ac);

    /** Get default access control policy */
    virtual PropertyAccessControl* getPropertyAccessControl();

    /** @name Actuators. User-functions that correspond to
message actions. */
    //@{

    /** Perform request-forward. (Request a port forward.  Sent from
      the client systemon the localnet to the firewall.  The gateway
      program on thefirewall should set up a port forward (either a
      simple user-levelredirect, or using available operating system
      firewalling such asLinux's iptables) to the client site so long
      as the client siteremains connected to the firewall.) */
    virtual void requestForward(LocalSocketSite* ls) = 0;

    //@}
};

/** Local version of Gateway. */

class LocalGateway : public virtual Gateway {

public:

    /** Constructor */
    LocalGateway(MetaObject* superobject);

    /** Destructor */
    ~LocalGateway();

    /** Initialize required subproperties with given access control. */
    virtual void initialize(PropertyAccessControl* ac);

    /** Initialize required subproperties. If access control has been
        previously set with initialize(PropertyAccessControl*) or
        setPropertyAccessControl(), then that policy will be used. Otherwise,
        NoPropertyAccessControl will be used.
    */
    virtual void initialize();

    /** Static generator, for factory. */
    static MetaObject* new_LocalGateway(MetaObject* superobject, const string& type);

    /**  @name Actuators. These methods correspond to messages. */
    //@{

    /** Perform request-forward. (Request a port forward.  Sent from
     * the client systemon the localnet to the firewall.  The gateway
     * program on thefirewall should set up a port forward (either a
     * simple user-levelredirect, or using available operating system
     * firewalling such asLinux's iptables) to the client site so long
     * as the client siteremains connected to the firewall.) */
    virtual void requestForward(LocalSocketSite* ls);

    //@}

protected:

    /** @name Message Handlers */

    /** Handle message request-forward (Request a port forward.  Sent
     * from the client systemon the localnet to the firewall.  The
     * gateway program on thefirewall should set up a port forward
     * (either a simple user-levelredirect, or using available
     * operating system firewalling such asLinux's iptables) to the
     * client site so long as the client siteremains connected to the
     * firewall.) */
    virtual void handleRequestForward(Message* m);
};

/** Remote proxy for Gateway */

class RemoteGateway : public virtual Gateway {

public:

    /** Constructor */
    RemoteGateway(MetaObject* superobject);

    /** Destructor */
    virtual ~RemoteGateway();

    /** Static generator, for factory. */
    static MetaObject* new_RemoteGateway(MetaObject* superobject, const string& type);

    /** @name Actuators.  These are user-functions corresponding to
        messages. The remote actuators marshal arguments and send a
        message to the Local object. */
    //@{

    /** Send a request-forward messsage to the local object. */
    virtual void requestForward(LocalSocketSite* ls);

    //@}
protected:

    /** @name Update Handlers. Handlers for remote update messages */
    //@{

    /** Handle a request-forward-reply messsage from the local object. */
    virtual void handleRequestForwardReply(Message* m);

    //@}
};


#endif // #ifndef _MISC_GATEWAY_HH_

---