PluginScript.h

Go to the documentation of this file.

/*---------------------------------------------------------------------\
|                          ____ _   __ __ ___                          |
|                         |__  / \ / / . \ . \                         |
|                           / / \ V /|  _/  _/                         |
|                          / /__ | | | | | |                           |
|                         /_____||_| |_| |_|                           |
|                                                                      |
\---------------------------------------------------------------------*/
#ifndef ZYPP_PLUGINSCRIPT_H
#define ZYPP_PLUGINSCRIPT_H

#include <iosfwd>
#include <string>
#include <vector>

#include <zypp-core/base/PtrTypes.h>
#include <zypp-core/Pathname.h>

#include <zypp-core/rpc/PluginFrame.h>
#include <zypp/PluginScriptException.h>

namespace zypp
{ 

  class PluginScript
  {
    friend std::ostream & operator<<( std::ostream & str, const PluginScript & obj );

    public:
      using Arguments = std::vector<std::string>;

      static const pid_t NotConnected;

    public:
        static long defaultSendTimeout();

        static long defaultReceiveTimeout();

        static void defaultSendTimeout( long newval_r );

        static void defaultReceiveTimeout( long newval_r );

        static void defaultTimeout( long newval_r )
        { defaultSendTimeout( newval_r ); defaultReceiveTimeout( newval_r ); }

    public:
      PluginScript();

      PluginScript( Pathname script_r );

      PluginScript( Pathname script_r, Arguments args_r );

    public:
      const Pathname & script() const;

      const Arguments & args() const;

      bool isOpen() const;

      pid_t getPid() const;

      Pathname getChroot() const;

      int lastReturn() const;

      const std::string & lastExecError() const;

     public:
        long sendTimeout() const;

        long receiveTimeout() const;

        void sendTimeout( long newval_r );

        void receiveTimeout( long newval_r );

        void timeout( long newval_r )
        { sendTimeout( newval_r ); receiveTimeout( newval_r ); }

   public:
      void open();

      void open( const Pathname & script_r );

      void open( const Pathname & script_r, const Arguments & args_r );

      void open( const Pathname & script_r, const Pathname & chroot_r );

      void open( const Pathname & script_r, const Arguments & args_r, const Pathname & chroot_r );

      void openChrooted( const Pathname & chroot_r );

      int close();

    public:
      void send( const PluginFrame & frame_r ) const;

      PluginFrame receive() const;

    public:
      struct Impl;
    private:
      RW_pointer<Impl> _pimpl;
  };

  std::ostream & operator<<( std::ostream & str, const PluginScript & obj );

} // namespace zypp
#endif // ZYPP_PLUGINSCRIPT_H