This repository has been archived by the owner on Feb 11, 2022. It is now read-only.
forked from aerospike/aerospike-client-go
-
Notifications
You must be signed in to change notification settings - Fork 0
/
client_policy.go
79 lines (65 loc) · 2.96 KB
/
client_policy.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
// Copyright 2013-2015 Aerospike, Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package aerospike
import (
"time"
)
const defaultIdleTimeout = 14 * time.Second
// ClientPolicy encapsulates parameters for client policy command.
type ClientPolicy struct {
// User authentication to cluster. Leave empty for clusters running without restricted access.
User string
// Password authentication to cluster. The password will be stored by the client and sent to server
// in hashed format. Leave empty for clusters running without restricted access.
Password string
// Initial host connection timeout in milliseconds. The timeout when opening a connection
// to the server host for the first time.
Timeout time.Duration //= 1 second
// Connection idle timeout. Every time a connection is used, its idle
// deadline will be extended by this duration. When this deadline is reached,
// the connection will be closed and discarded from the connection pool.
IdleTimeout time.Duration //= 14 seconds
// Size of the Connection Queue cache.
ConnectionQueueSize int //= 256
// If set to true, will not create a new connection
// to the node if there are already `ConnectionQueueSize` active connections.
LimitConnectionsToQueueSize bool //= false
// Throw exception if host connection fails during addHost().
FailIfNotConnected bool //= true
// TendInterval determines interval for checking for cluster state changes.
// Minimum possible interval is 10 Miliseconds.
TendInterval time.Duration //= 1 second
// A IP translation table is used in cases where different clients
// use different server IP addresses. This may be necessary when
// using clients from both inside and outside a local area
// network. Default is no translation.
// The key is the IP address returned from friend info requests to other servers.
// The value is the real IP address used to connect to the server.
IpMap map[string]string
}
// NewClientPolicy generates a new ClientPolicy with default values.
func NewClientPolicy() *ClientPolicy {
return &ClientPolicy{
Timeout: time.Second,
IdleTimeout: defaultIdleTimeout,
ConnectionQueueSize: 256,
FailIfNotConnected: true,
TendInterval: time.Second,
LimitConnectionsToQueueSize: false,
}
}
// RequiresAuthentication returns true if a USer or Password is set for ClientPolicy.
func (cp *ClientPolicy) RequiresAuthentication() bool {
return (cp.User != "") || (cp.Password != "")
}