1 /*
2 * #%L
3 * ClusterStats.java - mongodb-async-driver - Allanbank Consulting, Inc.
4 * %%
5 * Copyright (C) 2011 - 2014 Allanbank Consulting, Inc.
6 * %%
7 * Licensed under the Apache License, Version 2.0 (the "License");
8 * you may not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
10 *
11 * http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
18 * #L%
19 */
20 package com.allanbank.mongodb.client;
21
22 /**
23 * ClusterInformation provides information on the cluster.
24 *
25 * @api.no This class is <b>NOT</b> part of the drivers API. This class may be
26 * mutated in incompatible ways between any two releases of the driver.
27 * @copyright 2014, Allanbank Consulting, Inc., All Rights Reserved
28 */
29 public interface ClusterStats {
30 /**
31 * Returns the range of versions that we currently see within the cluster.
32 *
33 * @return Tthe range of versions that we currently see within the cluster.
34 */
35 public VersionRange getServerVersionRange();
36
37 /**
38 * Returns smallest value for the maximum number of write operations allowed
39 * in a single write command.
40 *
41 * @return The smallest value for maximum number of write operations allowed
42 * in a single write command.
43 */
44 public int getSmallestMaxBatchedWriteOperations();
45
46 /**
47 * Returns the lowest value for the maximum BSON object size within the
48 * cluster.
49 *
50 * @return The lowest value for the maximum BSON object size within the
51 * cluster.
52 */
53 public long getSmallestMaxBsonObjectSize();
54 }