Changed cvs_man.php -> scm_man.php.
[clearscm.git] / lib / Clearcase / Server.pm
1 =pod
2
3 =head1 NAME $RCSfile: Server.pm,v $
4
5 Object oriented interface to a Clearcase Server
6
7 =head1 VERSION
8
9 =over
10
11 =item Author
12
13 Andrew DeFaria <Andrew@ClearSCM.com>
14
15 =item Revision
16
17 $Revision: 1.2 $
18
19 =item Created
20
21 Sat Dec 18 09:51:15 EST 2010
22
23 =item Modified
24
25 $Date: 2011/01/02 04:59:36 $
26
27 =back
28
29 =head2 SYNOPSIS
30
31 Provides access to information about a Clearcase Server.
32 =head2 DESCRIPTION
33
34 This module implements an object oriented interface to a Clearcase
35 Server.
36
37 =head2 ROUTINES
38
39 The following routines are exported:
40
41 =cut
42
43 package Clearcase::Server;
44
45 use strict;
46 use warnings;
47
48 use Clearcase;
49
50 =pod
51
52 =head2 new (tag)
53
54 Construct a new Clearcase View object. Note that not all members are
55 initially populated because doing so would be time consuming. Such
56 member variables will be expanded when accessed.
57
58 Parameters:
59
60 =for html <blockquote>
61
62 =over
63
64 =item tag
65
66 View tag to be instantiated. You can use either an object oriented call
67 (i.e. my $view = new Clearcase::View (tag => 'my_new_view')) or the
68 normal call (i.e. my $vob = new Clearcase::View ('my_new_view')). You
69 can also instantiate a new view by supplying a tag and then later
70 calling the create method.
71
72 =back
73
74 =for html </blockquote>
75
76 Returns:
77
78 =for html <blockquote>
79
80 =over
81
82 =item Clearcase View object
83
84 =back
85
86 =for html </blockquote>
87
88 =cut
89
90 sub new ($;$) {
91   my ($class, $name) = @_;
92
93   my $self = bless { name => $name }, $class;
94
95   return $self;
96 } # new
97   
98 sub name () {
99   my ($self) = @_;
100
101   return $self->{name};
102 } # name
103
104 sub ccVer () {
105   my ($self) = @_;
106
107   return $self->{ccVer};
108 } # ccVer
109
110 sub osVer () {
111   my ($self) = @_;
112
113   return $self->{osVer};
114 } # osVer
115
116 sub hardware () {
117   my ($self) = @_;
118
119   return $self->{hardware};
120 } # hardware
121
122 sub licenseHost () {
123   my ($self) = @_;
124
125   return $self->{licenseHost};
126 } # licenseHost
127
128 sub registryHost () {
129   my ($self) = @_;
130
131   return $self->{registryHost};
132 } # registryHost
133
134 sub registryRegion () {
135   my ($self) = @_;
136
137   return $self->{registryRegion};
138 } # registryRegion
139
140 sub mvfsBlocksPerDirectory () {
141   my ($self) = @_;
142
143   return $self->{mvfsBlocksPerDirectory};
144 } # mvfsBlocksPerDirectory
145
146 sub mvfsCleartextMnodes () {
147   my ($self) = @_;
148  
149   return $self->{mvfsCleartextMnodes};
150 } # mvfsCleartextMnodes
151
152 sub mvfsDirectoryNames () {
153   my ($self) = @_;
154
155   return $self->{mvfsDirectoryNames};
156 } # mvfsDirectoryNames
157
158 sub mvfsFileNames () {
159   my ($self) = @_;
160
161   return $self->{mvfsFileNames};
162 } # mvfsFileNames
163
164 sub mvfsFreeMnodes () {
165   my ($self) = @_;
166
167   return $self->{mvfsFreeMnodes};
168 } # mvfsFreeMnodes
169
170 sub mvfsInitialMnodeTableSize () {
171   my ($self) = @_;
172
173   return $self->{mvfsInitialMnodeTableSize};
174 } # mvfsInitialMnodeTableSize
175
176 sub mvfsMinCleartextMnodes () {
177   my ($self) = @_;
178
179   return $self->{mvfsMinCleartextMnodes};
180 } # mvfsMinCleartextMnodes
181
182 sub mvfsMinFreeMnodes () {
183   my ($self) = @_;
184
185   return $self->{mvfsMinFreeMnodes};
186 } # mvfsMinFreeMnodes
187
188 sub mvfsNamesNotFound () {
189   my ($self) = @_;
190
191   return $self->{mvfsNamesNotFound};
192 } # mvfsNamesNotFound
193
194 sub mvfsRPCHandles () {
195   my ($self) = @_;
196
197   return $self->{mvfsRPCHandles};
198 } # mvfsRPCHandles
199
200 sub interopRegion () {
201   my ($self) = @_;
202
203   return $self->{interopRegion};
204 } # interopRegion
205
206 sub scalingFactor () {
207   my ($self) = @_;
208
209   return $self->{scalingFactor};
210 } # scalingFactor
211
212 sub cleartextIdleLifetime () {
213   my ($self) = @_;
214
215   return $self->{cleartextIdleLifetime};
216 } # cleartextIdleLifetime
217
218 sub vobHashTableSize () {
219   my ($self) = @_;
220
221   return $self->{vobHashTableSize};
222 } # vobHashTableSize
223
224 sub cleartextHashTableSize () {
225   my ($self) = @_;
226
227   return $self->{cleartextHashTableSize};
228 } # cleartextHashTableSize
229
230 sub dncHashTableSize () {
231   my ($self) = @_;
232
233   return $self->{dncHashTableSize};
234 } # dncHashTableSize
235
236 sub threadHashTableSize () {
237   my ($self) = @_;
238
239   return $self->{threadHashTableSize};
240 } # threadHashTableSize
241
242 sub processHashTableSize () {
243   my ($self) = @_;
244
245   return $self->{processHashTableSize};
246 } # processHashTableSize
247
248 1;
249
250 =pod
251
252 =head2 DEPENDENCIES
253
254 =for html <p><a href="/php/scm_man.php?file=lib/Clearcase.pm">Clearcase</a></p>
255
256 =head2 INCOMPATABILITIES
257
258 None
259
260 =head2 BUGS AND LIMITATIONS
261
262 There are no known bugs in this module.
263
264 Please report problems to Andrew DeFaria <Andrew@ClearSCM.com>.
265
266 =head2 LICENSE AND COPYRIGHT
267
268 Copyright (c) 2007, ClearSCM, Inc. All rights reserved.
269
270 =cut