MediaChangerProxy.hpp 2.39 KB
Newer Older
1
2
3
/*
 * The CERN Tape Archive(CTA) project
 * Copyright(C) 2015  CERN
4
 *
5
6
7
8
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 *(at your option) any later version.
9
10
11
12
13
14
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
15
16
17
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
18
19
20

#pragma once

21
#include "mediachanger/LibrarySlot.hpp"
22
23
24
25
26
27
28
29

#include <stdint.h>
#include <string>

namespace cta {
namespace mediachanger {

/**
30
31
 * Abstract class defining the interface to a proxy object representing a
 * media changer daemon.
32
 */
33
class MediaChangerProxy {
34
35
36
37
38
public:

  /**
   * Destructor.
   */
39
  virtual ~MediaChangerProxy()  = 0;
40
41

  /**
42
   * Request the media changer daemon to mount the specified tape for read-only
43
44
45
46
47
48
49
50
   * access into the tape drive in the specified library slot.
   *
   * Please note that this method provides a best-effort service because not all
   * media changers support read-only mounts.
   *
   * @param vid The volume identifier of the tape to be mounted.
   * @param librarySlot The slot in the library that contains the tape drive.
   */
51
  virtual void mountTapeReadOnly(const std::string &vid, const LibrarySlot &librarySlot) = 0;
52
53
  
  /**
54
   * Request the media changer daemon to mount the specifed tape for read/write
55
56
57
58
59
   * access into the tape drive in the specified library slot.
   *
   * @param vid The volume identifier of the tape to be mounted.
   * @param librarySlot The slot in the library that contains the tape drive.
   */
60
  virtual void mountTapeReadWrite(const std::string &vid, const LibrarySlot &librarySlot) = 0;
61
62
  
  /**
63
64
   * Request the media changer daemon to dismount the specifed tape from the
   * tape drive in the specified library slot.
65
66
67
68
   *
   * @param vid The volume identifier of the tape to be mounted.
   * @param librarySlot The slot in the library that contains the tape drive.
   */
69
  virtual void dismountTape(const std::string &vid, const LibrarySlot &librarySlot) = 0;
70

71
}; // class MediaChangerProxy
72
73
74
75

} // namespace mediachanger
} // namespace cta