softwarecontainer  0.18.0-739e8d7 2017-05-04
softwarecontainerabstractinterface.h
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2017 Pelagicore AB
3  *
4  * Permission to use, copy, modify, and/or distribute this software for
5  * any purpose with or without fee is hereby granted, provided that the
6  * above copyright notice and this permission notice appear in all copies.
7  *
8  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
9  * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
10  * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR
11  * BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES
12  * OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
13  * WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
14  * ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
15  * SOFTWARE.
16  *
17  * For further information see LICENSE
18  */
19 
24 #pragma once
25 
26 #include "commandjob.h"
27 #include "gatewayconfig.h"
28 
29 namespace softwarecontainer {
30 
32 {
33 public:
34 
36 
52  virtual bool startGateways(const GatewayConfiguration &configs) = 0;
53 
62  virtual std::shared_ptr<CommandJob> createCommandJob(const std::string &command) = 0;
63 
72  virtual void shutdown(unsigned int timeout) = 0;
73 
89  virtual void suspend() = 0;
90 
105  virtual void resume() = 0;
106 
113  virtual bool bindMount(const std::string &pathOnHost,
114  const std::string &pathInContainer,
115  bool readonly = true) = 0;
116 
127  virtual bool previouslyConfigured() = 0;
128 };
129 
130 } //namespace
virtual bool startGateways(const GatewayConfiguration &configs)=0
Starts the Gateways by setting the gateway configurations and activating the configured gateway...
virtual bool bindMount(const std::string &pathOnHost, const std::string &pathInContainer, bool readonly=true)=0
Should only be called on containers in state &#39;READY&#39;.
virtual std::shared_ptr< CommandJob > createCommandJob(const std::string &command)=0
Create a job that can run a command in a container.
virtual void suspend()=0
Suspend the container.
virtual void resume()=0
Resume a suspended container.
Developers guide to adding a config item:
virtual bool previouslyConfigured()=0
Indicates if gateways have been configured previously.
virtual void shutdown(unsigned int timeout)=0
Shot down the container with an explicit timeout.