Move ServerDescription into its own header.
[dcpomatic.git] / src / lib / server_description.h
1 /*
2     Copyright (C) 2012 Carl Hetherington <cth@carlh.net>
3
4     This program is free software; you can redistribute it and/or modify
5     it under the terms of the GNU General Public License as published by
6     the Free Software Foundation; either version 2 of the License, or
7     (at your option) any later version.
8
9     This program is distributed in the hope that it will be useful,
10     but WITHOUT ANY WARRANTY; without even the implied warranty of
11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12     GNU General Public License for more details.
13
14     You should have received a copy of the GNU General Public License
15     along with this program; if not, write to the Free Software
16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
17
18 */
19
20 /** @class ServerDescription
21  *  @brief Class to describe a server to which we can send encoding work.
22  */
23 class ServerDescription
24 {
25 public:
26         ServerDescription ()
27                 : _host_name ("")
28                 , _threads (1)
29         {}
30
31         /** @param h Server host name or IP address in string form.
32          *  @param t Number of threads to use on the server.
33          */
34         ServerDescription (std::string h, int t)
35                 : _host_name (h)
36                 , _threads (t)
37         {}
38
39         /* Default copy constructor is fine */
40
41         /** @return server's host name or IP address in string form */
42         std::string host_name () const {
43                 return _host_name;
44         }
45
46         /** @return number of threads to use on the server */
47         int threads () const {
48                 return _threads;
49         }
50
51         void set_host_name (std::string n) {
52                 _host_name = n;
53         }
54
55         void set_threads (int t) {
56                 _threads = t;
57         }
58
59 private:
60         /** server's host name */
61         std::string _host_name;
62         /** number of threads to use on the server */
63         int _threads;
64 };