faye 0.6.8 → 0.7.0
Sign up to get free protection for your applications and to get access to all the features.
Potentially problematic release.
This version of faye might be problematic. Click here for more details.
- data/History.txt +10 -3
- data/README.rdoc +1 -2
- data/lib/faye-browser-min.js +1 -1
- data/lib/faye.rb +89 -32
- data/lib/faye/adapters/rack_adapter.rb +20 -26
- data/lib/faye/engines/base.rb +5 -0
- data/lib/faye/engines/memory.rb +9 -3
- data/lib/faye/engines/redis.rb +26 -11
- data/lib/faye/mixins/publisher.rb +4 -8
- data/lib/faye/protocol/channel.rb +8 -8
- data/lib/faye/protocol/client.rb +45 -4
- data/lib/faye/protocol/publication.rb +5 -0
- data/lib/faye/protocol/server.rb +10 -19
- data/lib/faye/thin_extensions.rb +1 -1
- data/lib/faye/transport/http.rb +17 -8
- data/lib/faye/transport/local.rb +6 -3
- data/lib/faye/transport/transport.rb +23 -9
- data/lib/faye/transport/web_socket.rb +102 -0
- data/lib/faye/util/web_socket.rb +34 -80
- data/lib/faye/util/web_socket/api.rb +103 -0
- data/lib/faye/util/web_socket/client.rb +82 -0
- data/lib/faye/util/web_socket/draft75_parser.rb +3 -5
- data/lib/faye/util/web_socket/draft76_parser.rb +5 -7
- data/lib/faye/util/web_socket/protocol8_parser.rb +111 -46
- data/spec/javascript/client_spec.js +99 -7
- data/spec/javascript/engine_spec.js +116 -3
- data/spec/javascript/node_adapter_spec.js +2 -4
- data/spec/javascript/server/handshake_spec.js +0 -12
- data/spec/javascript/server/integration_spec.js +74 -29
- data/spec/javascript/server_spec.js +0 -11
- data/spec/javascript/web_socket/client_spec.js +121 -0
- data/spec/javascript/web_socket/protocol8parser_spec.js +26 -3
- data/spec/node.js +2 -0
- data/spec/redis.conf +10 -280
- data/spec/ruby/client_spec.rb +101 -8
- data/spec/ruby/engine_spec.rb +106 -0
- data/spec/ruby/server/handshake_spec.rb +0 -12
- data/spec/ruby/server/integration_spec.rb +56 -18
- data/spec/ruby/server_spec.rb +1 -12
- data/spec/ruby/transport_spec.rb +14 -8
- data/spec/ruby/web_socket/client_spec.rb +126 -0
- data/spec/ruby/web_socket/protocol8_parser_spec.rb +28 -3
- metadata +96 -150
@@ -29,17 +29,6 @@ JS.ENV.ServerSpec = JS.Test.describe("Server", function() { with(this) {
|
|
29
29
|
server.process([{}, {channel: "invalid"}], false, function(r) { response = r})
|
30
30
|
assertEqual( [], response )
|
31
31
|
}})
|
32
|
-
|
33
|
-
it("rejects unknown meta channels", function() { with(this) {
|
34
|
-
var response = null
|
35
|
-
server.process([{channel: "/meta/p"}], false, function(r) { response = r })
|
36
|
-
assertEqual([
|
37
|
-
{ channel: "/meta/p",
|
38
|
-
successful: false,
|
39
|
-
error: "403:/meta/p:Forbidden channel"
|
40
|
-
}
|
41
|
-
], response)
|
42
|
-
}})
|
43
32
|
|
44
33
|
it("routes single messages to appropriate handlers", function() { with(this) {
|
45
34
|
expect(server, "handshake").given(handshake, false).yielding([{}])
|
@@ -0,0 +1,121 @@
|
|
1
|
+
JS.ENV.WebSocket = JS.ENV.WebSocket || {}
|
2
|
+
|
3
|
+
JS.ENV.WebSocketSteps = JS.ENV.IntegrationSteps = JS.Test.asyncSteps({
|
4
|
+
server: function(port, callback) {
|
5
|
+
this._adapter = new Faye.NodeAdapter({mount: "/bayeux", timeout: 25})
|
6
|
+
this._adapter.listen(port)
|
7
|
+
this._port = port
|
8
|
+
setTimeout(callback, 100)
|
9
|
+
},
|
10
|
+
|
11
|
+
stop: function(callback) {
|
12
|
+
this._adapter.stop()
|
13
|
+
setTimeout(callback, 100)
|
14
|
+
},
|
15
|
+
|
16
|
+
open_socket: function(url, callback) {
|
17
|
+
var done = false,
|
18
|
+
self = this,
|
19
|
+
|
20
|
+
resume = function(open) {
|
21
|
+
if (done) return
|
22
|
+
done = true
|
23
|
+
self._open = open
|
24
|
+
callback()
|
25
|
+
}
|
26
|
+
|
27
|
+
this._ws = new Faye.WebSocket.Client(url)
|
28
|
+
|
29
|
+
this._ws.onopen = function() { resume(true) }
|
30
|
+
this._ws.onclose = function() { resume(false) }
|
31
|
+
},
|
32
|
+
|
33
|
+
close_socket: function(callback) {
|
34
|
+
var self = this
|
35
|
+
this._ws.onclose = function() {
|
36
|
+
self._open = false
|
37
|
+
callback()
|
38
|
+
}
|
39
|
+
this._ws.close()
|
40
|
+
},
|
41
|
+
|
42
|
+
check_open: function(callback) {
|
43
|
+
this.assert( this._open )
|
44
|
+
callback()
|
45
|
+
},
|
46
|
+
|
47
|
+
check_closed: function(callback) {
|
48
|
+
this.assert( !this._open )
|
49
|
+
callback()
|
50
|
+
},
|
51
|
+
|
52
|
+
listen_for_message: function(callback) {
|
53
|
+
var self = this
|
54
|
+
this._ws.onmessage = function(message) { self._message = message.data }
|
55
|
+
callback()
|
56
|
+
},
|
57
|
+
|
58
|
+
send_subscribe: function(callback) {
|
59
|
+
this._ws.send(JSON.stringify({channel: "/meta/subscribe", subscription: "/ws"}))
|
60
|
+
setTimeout(callback, 100)
|
61
|
+
},
|
62
|
+
|
63
|
+
check_subscribe_response: function(callback) {
|
64
|
+
this.assertEqual( [{ channel: "/meta/subscribe",
|
65
|
+
error: "402:clientId:Missing required parameter",
|
66
|
+
subscription: "/ws",
|
67
|
+
successful: false
|
68
|
+
}],
|
69
|
+
JSON.parse(this._message) )
|
70
|
+
callback()
|
71
|
+
},
|
72
|
+
|
73
|
+
check_no_response: function(callback) {
|
74
|
+
this.assert( !this._message )
|
75
|
+
callback()
|
76
|
+
}
|
77
|
+
})
|
78
|
+
|
79
|
+
JS.ENV.WebSocket.ClientSpec = JS.Test.describe("WebSocket.Client", function() { with(this) {
|
80
|
+
include(WebSocketSteps)
|
81
|
+
|
82
|
+
before(function() { this.server(8000) })
|
83
|
+
after (function() { this.stop() })
|
84
|
+
|
85
|
+
it("can open a connection", function() { with(this) {
|
86
|
+
open_socket("ws://localhost:8000/bayeux")
|
87
|
+
check_open()
|
88
|
+
}})
|
89
|
+
|
90
|
+
it("can close the connection", function() { with(this) {
|
91
|
+
open_socket("ws://localhost:8000/bayeux")
|
92
|
+
close_socket()
|
93
|
+
check_closed()
|
94
|
+
}})
|
95
|
+
|
96
|
+
describe("in the OPEN state", function() { with(this) {
|
97
|
+
before(function() { with(this) {
|
98
|
+
open_socket("ws://localhost:8000/bayeux")
|
99
|
+
}})
|
100
|
+
|
101
|
+
it("can send and receive messages", function() { with(this) {
|
102
|
+
listen_for_message()
|
103
|
+
send_subscribe()
|
104
|
+
check_subscribe_response()
|
105
|
+
}})
|
106
|
+
}})
|
107
|
+
|
108
|
+
describe("in the CLOSED state", function() { with(this) {
|
109
|
+
before(function() { with(this) {
|
110
|
+
open_socket("ws://localhost:8000/bayeux")
|
111
|
+
close_socket()
|
112
|
+
}})
|
113
|
+
|
114
|
+
it("cannot send and receive messages", function() { with(this) {
|
115
|
+
listen_for_message()
|
116
|
+
send_subscribe()
|
117
|
+
check_no_response()
|
118
|
+
}})
|
119
|
+
}})
|
120
|
+
}})
|
121
|
+
|
@@ -13,6 +13,14 @@ JS.ENV.WebSocket.Protocol8ParserSpec = JS.Test.describe("WebSocket.Protocol8Pars
|
|
13
13
|
this.parser.parse(new Buffer(bytes))
|
14
14
|
})
|
15
15
|
|
16
|
+
define("buffer", function(string) {
|
17
|
+
return {
|
18
|
+
equals: function(buffer) {
|
19
|
+
return buffer.toString('utf8', 0, buffer.length) === string
|
20
|
+
}
|
21
|
+
}
|
22
|
+
})
|
23
|
+
|
16
24
|
describe("parse", function() { with(this) {
|
17
25
|
define("mask", function() {
|
18
26
|
return this._mask = this._mask || Faye.map([1,2,3,4], function() { return Math.floor(Math.random() * 255) })
|
@@ -31,6 +39,11 @@ JS.ENV.WebSocket.Protocol8ParserSpec = JS.Test.describe("WebSocket.Protocol8Pars
|
|
31
39
|
parse([0x81, 0x05, 0x48, 0x65, 0x6c, 0x6c, 0x6f])
|
32
40
|
}})
|
33
41
|
|
42
|
+
it("parses empty text frames", function() { with(this) {
|
43
|
+
expect(webSocket, "receive").given("")
|
44
|
+
parse([0x81, 0x00])
|
45
|
+
}})
|
46
|
+
|
34
47
|
it("parses fragmented text frames", function() { with(this) {
|
35
48
|
expect(webSocket, "receive").given("Hello")
|
36
49
|
parse([0x01, 0x03, 0x48, 0x65, 0x6c])
|
@@ -42,6 +55,11 @@ JS.ENV.WebSocket.Protocol8ParserSpec = JS.Test.describe("WebSocket.Protocol8Pars
|
|
42
55
|
parse([0x81, 0x85], mask(), maskMessage([0x48, 0x65, 0x6c, 0x6c, 0x6f]))
|
43
56
|
}})
|
44
57
|
|
58
|
+
it("parses masked empty text frames", function() { with(this) {
|
59
|
+
expect(webSocket, "receive").given("")
|
60
|
+
parse([0x81, 0x80], mask(), maskMessage([]))
|
61
|
+
}})
|
62
|
+
|
45
63
|
it("parses masked fragmented text frames", function() { with(this) {
|
46
64
|
expect(webSocket, "receive").given("Hello")
|
47
65
|
parse([0x01, 0x81], mask(), maskMessage([0x48]))
|
@@ -49,10 +67,15 @@ JS.ENV.WebSocket.Protocol8ParserSpec = JS.Test.describe("WebSocket.Protocol8Pars
|
|
49
67
|
}})
|
50
68
|
|
51
69
|
it("closes the socket if the frame has an unrecognized opcode", function() { with(this) {
|
52
|
-
expect(webSocket, "close").given(
|
70
|
+
expect(webSocket, "close").given(1002, null, false)
|
53
71
|
parse([0x83, 0x00])
|
54
72
|
}})
|
55
73
|
|
74
|
+
it("closes the socket if a close frame is received", function() { with(this) {
|
75
|
+
expect(webSocket, "close").given(1000, "Hello", false)
|
76
|
+
parse([0x88, 0x07, 0x03, 0xe8, 0x48, 0x65, 0x6c, 0x6c, 0x6f])
|
77
|
+
}})
|
78
|
+
|
56
79
|
it("parses unmasked multibyte text frames", function() { with(this) {
|
57
80
|
expect(webSocket, "receive").given("Apple = ")
|
58
81
|
parse([0x81, 0x0b, 0x41, 0x70, 0x70, 0x6c, 0x65, 0x20, 0x3d, 0x20, 0xef, 0xa3, 0xbf])
|
@@ -86,7 +109,7 @@ JS.ENV.WebSocket.Protocol8ParserSpec = JS.Test.describe("WebSocket.Protocol8Pars
|
|
86
109
|
}})
|
87
110
|
|
88
111
|
it("replies to pings with a pong", function() { with(this) {
|
89
|
-
expect(webSocket, "send").given("OHAI", "pong")
|
112
|
+
expect(webSocket, "send").given(buffer("OHAI"), "pong")
|
90
113
|
parse([0x89, 0x04, 0x4f, 0x48, 0x41, 0x49])
|
91
114
|
}})
|
92
115
|
}})
|
@@ -118,7 +141,7 @@ JS.ENV.WebSocket.Protocol8ParserSpec = JS.Test.describe("WebSocket.Protocol8Pars
|
|
118
141
|
}})
|
119
142
|
|
120
143
|
it("encodes close frames with an error code", function() { with(this) {
|
121
|
-
parser.frame("Hello", "close",
|
144
|
+
parser.frame("Hello", "close", 1002)
|
122
145
|
assertEqual( [0x88, 0x07, 0x03, 0xea, 0x48, 0x65, 0x6c, 0x6c, 0x6f], socket.read() )
|
123
146
|
}})
|
124
147
|
|
data/spec/node.js
CHANGED
@@ -20,6 +20,7 @@ FakeSocket.prototype.read = function() {
|
|
20
20
|
})
|
21
21
|
return output
|
22
22
|
}
|
23
|
+
FakeSocket.prototype.addListener = function() {}
|
23
24
|
|
24
25
|
JS.require('Faye', 'JS.Test', 'JS.Range', function() {
|
25
26
|
JS.Test.Unit.Assertions.include({
|
@@ -43,6 +44,7 @@ JS.require('Faye', 'JS.Test', 'JS.Range', function() {
|
|
43
44
|
'Server.UnsubscribeSpec',
|
44
45
|
'Server.ExtensionsSpec',
|
45
46
|
'Server.IntegrationSpec',
|
47
|
+
'WebSocket.ClientSpec',
|
46
48
|
'WebSocket.Draft75ParserSpec',
|
47
49
|
'WebSocket.Protocol8ParserSpec',
|
48
50
|
'NodeAdapterSpec',
|
data/spec/redis.conf
CHANGED
@@ -1,312 +1,42 @@
|
|
1
|
-
# Redis configuration file example
|
2
|
-
|
3
|
-
# Note on units: when memory size is needed, it is possible to specifiy
|
4
|
-
# it in the usual form of 1k 5GB 4M and so forth:
|
5
|
-
#
|
6
|
-
# 1k => 1000 bytes
|
7
|
-
# 1kb => 1024 bytes
|
8
|
-
# 1m => 1000000 bytes
|
9
|
-
# 1mb => 1024*1024 bytes
|
10
|
-
# 1g => 1000000000 bytes
|
11
|
-
# 1gb => 1024*1024*1024 bytes
|
12
|
-
#
|
13
|
-
# units are case insensitive so 1GB 1Gb 1gB are all the same.
|
14
|
-
|
15
|
-
# By default Redis does not run as a daemon. Use 'yes' if you need it.
|
16
|
-
# Note that Redis will write a pid file in /usr/local/var/run/redis.pid when daemonized.
|
17
1
|
daemonize no
|
18
|
-
|
19
|
-
# When running daemonized, Redis writes a pid file in /usr/local/var/run/redis.pid by
|
20
|
-
# default. You can specify a custom pid file location here.
|
21
|
-
pidfile /usr/local/var/run/redis.pid
|
22
|
-
|
23
|
-
# Accept connections on the specified port, default is 6379
|
2
|
+
pidfile /tmp/redis.pid
|
24
3
|
port 6379
|
25
|
-
|
26
|
-
# If you want you can bind a single interface, if the bind option is not
|
27
|
-
# specified all the interfaces will listen for incoming connections.
|
28
|
-
#
|
29
|
-
# bind 127.0.0.1
|
30
|
-
|
31
|
-
# Close the connection after a client is idle for N seconds (0 to disable)
|
4
|
+
unixsocket /tmp/redis.sock
|
32
5
|
timeout 300
|
33
|
-
|
34
|
-
# Set server verbosity to 'debug'
|
35
|
-
# it can be one of:
|
36
|
-
# debug (a lot of information, useful for development/testing)
|
37
|
-
# verbose (many rarely useful info, but not a mess like the debug level)
|
38
|
-
# notice (moderately verbose, what you want in production probably)
|
39
|
-
# warning (only very important / critical messages are logged)
|
40
6
|
loglevel verbose
|
41
|
-
|
42
|
-
# Specify the log file name. Also 'stdout' can be used to force
|
43
|
-
# Redis to log on the standard output. Note that if you use standard
|
44
|
-
# output for logging but daemonize, logs will be sent to /dev/null
|
45
7
|
logfile stdout
|
46
|
-
|
47
|
-
# Set the number of databases. The default database is DB 0, you can select
|
48
|
-
# a different one on a per-connection basis using SELECT <dbid> where
|
49
|
-
# dbid is a number between 0 and 'databases'-1
|
50
8
|
databases 16
|
51
9
|
|
52
|
-
################################ SNAPSHOTTING #################################
|
53
|
-
#
|
54
|
-
# Save the DB on disk:
|
55
|
-
#
|
56
|
-
# save <seconds> <changes>
|
57
|
-
#
|
58
|
-
# Will save the DB if both the given number of seconds and the given
|
59
|
-
# number of write operations against the DB occurred.
|
60
|
-
#
|
61
|
-
# In the example below the behaviour will be to save:
|
62
|
-
# after 900 sec (15 min) if at least 1 key changed
|
63
|
-
# after 300 sec (5 min) if at least 10 keys changed
|
64
|
-
# after 60 sec if at least 10000 keys changed
|
65
|
-
#
|
66
|
-
# Note: you can disable saving at all commenting all the "save" lines.
|
67
|
-
|
68
10
|
save 900 1
|
69
11
|
save 300 10
|
70
12
|
save 60 10000
|
71
13
|
|
72
|
-
# Compress string objects using LZF when dump .rdb databases?
|
73
|
-
# For default that's set to 'yes' as it's almost always a win.
|
74
|
-
# If you want to save some CPU in the saving child set it to 'no' but
|
75
|
-
# the dataset will likely be bigger if you have compressible values or keys.
|
76
14
|
rdbcompression yes
|
77
|
-
|
78
|
-
# The filename where to dump the DB
|
79
15
|
dbfilename dump.rdb
|
16
|
+
dir ./
|
80
17
|
|
81
|
-
|
82
|
-
#
|
83
|
-
# The DB will be written inside this directory, with the filename specified
|
84
|
-
# above using the 'dbfilename' configuration directive.
|
85
|
-
#
|
86
|
-
# Also the Append Only File will be created inside this directory.
|
87
|
-
#
|
88
|
-
# Note that you must specify a directory here, not a file name.
|
89
|
-
dir /usr/local/var/db/redis/
|
90
|
-
|
91
|
-
################################# REPLICATION #################################
|
18
|
+
slave-serve-stale-data yes
|
92
19
|
|
93
|
-
# Master-Slave replication. Use slaveof to make a Redis instance a copy of
|
94
|
-
# another Redis server. Note that the configuration is local to the slave
|
95
|
-
# so for example it is possible to configure the slave to save the DB with a
|
96
|
-
# different interval, or to listen to another port, and so on.
|
97
|
-
#
|
98
|
-
# slaveof <masterip> <masterport>
|
99
|
-
|
100
|
-
# If the master is password protected (using the "requirepass" configuration
|
101
|
-
# directive below) it is possible to tell the slave to authenticate before
|
102
|
-
# starting the replication synchronization process, otherwise the master will
|
103
|
-
# refuse the slave request.
|
104
|
-
#
|
105
|
-
# masterauth <master-password>
|
106
|
-
|
107
|
-
################################## SECURITY ###################################
|
108
|
-
|
109
|
-
# Require clients to issue AUTH <PASSWORD> before processing any other
|
110
|
-
# commands. This might be useful in environments in which you do not trust
|
111
|
-
# others with access to the host running redis-server.
|
112
|
-
#
|
113
|
-
# This should stay commented out for backward compatibility and because most
|
114
|
-
# people do not need auth (e.g. they run their own servers).
|
115
|
-
#
|
116
|
-
# Warning: since Redis is pretty fast an outside user can try up to
|
117
|
-
# 150k passwords per second against a good box. This means that you should
|
118
|
-
# use a very strong password otherwise it will be very easy to break.
|
119
|
-
#
|
120
20
|
requirepass foobared
|
121
21
|
|
122
|
-
################################### LIMITS ####################################
|
123
|
-
|
124
|
-
# Set the max number of connected clients at the same time. By default there
|
125
|
-
# is no limit, and it's up to the number of file descriptors the Redis process
|
126
|
-
# is able to open. The special value '0' means no limits.
|
127
|
-
# Once the limit is reached Redis will close all the new connections sending
|
128
|
-
# an error 'max number of clients reached'.
|
129
|
-
#
|
130
|
-
# maxclients 128
|
131
|
-
|
132
|
-
# Don't use more memory than the specified amount of bytes.
|
133
|
-
# When the memory limit is reached Redis will try to remove keys with an
|
134
|
-
# EXPIRE set. It will try to start freeing keys that are going to expire
|
135
|
-
# in little time and preserve keys with a longer time to live.
|
136
|
-
# Redis will also try to remove objects from free lists if possible.
|
137
|
-
#
|
138
|
-
# If all this fails, Redis will start to reply with errors to commands
|
139
|
-
# that will use more memory, like SET, LPUSH, and so on, and will continue
|
140
|
-
# to reply to most read-only commands like GET.
|
141
|
-
#
|
142
|
-
# WARNING: maxmemory can be a good idea mainly if you want to use Redis as a
|
143
|
-
# 'state' server or cache, not as a real DB. When Redis is used as a real
|
144
|
-
# database the memory usage will grow over the weeks, it will be obvious if
|
145
|
-
# it is going to use too much memory in the long run, and you'll have the time
|
146
|
-
# to upgrade. With maxmemory after the limit is reached you'll start to get
|
147
|
-
# errors for write operations, and this may even lead to DB inconsistency.
|
148
|
-
#
|
149
|
-
# maxmemory <bytes>
|
150
|
-
|
151
|
-
############################## APPEND ONLY MODE ###############################
|
152
|
-
|
153
|
-
# By default Redis asynchronously dumps the dataset on disk. If you can live
|
154
|
-
# with the idea that the latest records will be lost if something like a crash
|
155
|
-
# happens this is the preferred way to run Redis. If instead you care a lot
|
156
|
-
# about your data and don't want to that a single record can get lost you should
|
157
|
-
# enable the append only mode: when this mode is enabled Redis will append
|
158
|
-
# every write operation received in the file appendonly.aof. This file will
|
159
|
-
# be read on startup in order to rebuild the full dataset in memory.
|
160
|
-
#
|
161
|
-
# Note that you can have both the async dumps and the append only file if you
|
162
|
-
# like (you have to comment the "save" statements above to disable the dumps).
|
163
|
-
# Still if append only mode is enabled Redis will load the data from the
|
164
|
-
# log file at startup ignoring the dump.rdb file.
|
165
|
-
#
|
166
|
-
# IMPORTANT: Check the BGREWRITEAOF to check how to rewrite the append
|
167
|
-
# log file in background when it gets too big.
|
168
|
-
|
169
22
|
appendonly no
|
170
|
-
|
171
|
-
# The name of the append only file (default: "appendonly.aof")
|
172
|
-
# appendfilename appendonly.aof
|
173
|
-
|
174
|
-
# The fsync() call tells the Operating System to actually write data on disk
|
175
|
-
# instead to wait for more data in the output buffer. Some OS will really flush
|
176
|
-
# data on disk, some other OS will just try to do it ASAP.
|
177
|
-
#
|
178
|
-
# Redis supports three different modes:
|
179
|
-
#
|
180
|
-
# no: don't fsync, just let the OS flush the data when it wants. Faster.
|
181
|
-
# always: fsync after every write to the append only log . Slow, Safest.
|
182
|
-
# everysec: fsync only if one second passed since the last fsync. Compromise.
|
183
|
-
#
|
184
|
-
# The default is "everysec" that's usually the right compromise between
|
185
|
-
# speed and data safety. It's up to you to understand if you can relax this to
|
186
|
-
# "no" that will will let the operating system flush the output buffer when
|
187
|
-
# it wants, for better performances (but if you can live with the idea of
|
188
|
-
# some data loss consider the default persistence mode that's snapshotting),
|
189
|
-
# or on the contrary, use "always" that's very slow but a bit safer than
|
190
|
-
# everysec.
|
191
|
-
#
|
192
|
-
# If unsure, use "everysec".
|
193
|
-
|
194
|
-
# appendfsync always
|
195
23
|
appendfsync everysec
|
196
|
-
|
197
|
-
|
198
|
-
################################ VIRTUAL MEMORY ###############################
|
199
|
-
|
200
|
-
# Virtual Memory allows Redis to work with datasets bigger than the actual
|
201
|
-
# amount of RAM needed to hold the whole dataset in memory.
|
202
|
-
# In order to do so very used keys are taken in memory while the other keys
|
203
|
-
# are swapped into a swap file, similarly to what operating systems do
|
204
|
-
# with memory pages.
|
205
|
-
#
|
206
|
-
# To enable VM just set 'vm-enabled' to yes, and set the following three
|
207
|
-
# VM parameters accordingly to your needs.
|
24
|
+
no-appendfsync-on-rewrite no
|
208
25
|
|
209
26
|
vm-enabled no
|
210
|
-
# vm-enabled yes
|
211
|
-
|
212
|
-
# This is the path of the Redis swap file. As you can guess, swap files
|
213
|
-
# can't be shared by different Redis instances, so make sure to use a swap
|
214
|
-
# file for every redis process you are running. Redis will complain if the
|
215
|
-
# swap file is already in use.
|
216
|
-
#
|
217
|
-
# The best kind of storage for the Redis swap file (that's accessed at random)
|
218
|
-
# is a Solid State Disk (SSD).
|
219
|
-
#
|
220
|
-
# *** WARNING *** if you are using a shared hosting the default of putting
|
221
|
-
# the swap file under /tmp is not secure. Create a dir with access granted
|
222
|
-
# only to Redis user and configure Redis to create the swap file there.
|
223
27
|
vm-swap-file /tmp/redis.swap
|
224
|
-
|
225
|
-
# vm-max-memory configures the VM to use at max the specified amount of
|
226
|
-
# RAM. Everything that deos not fit will be swapped on disk *if* possible, that
|
227
|
-
# is, if there is still enough contiguous space in the swap file.
|
228
|
-
#
|
229
|
-
# With vm-max-memory 0 the system will swap everything it can. Not a good
|
230
|
-
# default, just specify the max amount of RAM you can in bytes, but it's
|
231
|
-
# better to leave some margin. For instance specify an amount of RAM
|
232
|
-
# that's more or less between 60 and 80% of your free RAM.
|
233
28
|
vm-max-memory 0
|
234
|
-
|
235
|
-
# Redis swap files is split into pages. An object can be saved using multiple
|
236
|
-
# contiguous pages, but pages can't be shared between different objects.
|
237
|
-
# So if your page is too big, small objects swapped out on disk will waste
|
238
|
-
# a lot of space. If you page is too small, there is less space in the swap
|
239
|
-
# file (assuming you configured the same number of total swap file pages).
|
240
|
-
#
|
241
|
-
# If you use a lot of small objects, use a page size of 64 or 32 bytes.
|
242
|
-
# If you use a lot of big objects, use a bigger page size.
|
243
|
-
# If unsure, use the default :)
|
244
29
|
vm-page-size 32
|
245
|
-
|
246
|
-
# Number of total memory pages in the swap file.
|
247
|
-
# Given that the page table (a bitmap of free/used pages) is taken in memory,
|
248
|
-
# every 8 pages on disk will consume 1 byte of RAM.
|
249
|
-
#
|
250
|
-
# The total swap size is vm-page-size * vm-pages
|
251
|
-
#
|
252
|
-
# With the default of 32-bytes memory pages and 134217728 pages Redis will
|
253
|
-
# use a 4 GB swap file, that will use 16 MB of RAM for the page table.
|
254
|
-
#
|
255
|
-
# It's better to use the smallest acceptable value for your application,
|
256
|
-
# but the default is large in order to work in most conditions.
|
257
30
|
vm-pages 134217728
|
258
|
-
|
259
|
-
# Max number of VM I/O threads running at the same time.
|
260
|
-
# This threads are used to read/write data from/to swap file, since they
|
261
|
-
# also encode and decode objects from disk to memory or the reverse, a bigger
|
262
|
-
# number of threads can help with big objects even if they can't help with
|
263
|
-
# I/O itself as the physical device may not be able to couple with many
|
264
|
-
# reads/writes operations at the same time.
|
265
|
-
#
|
266
|
-
# The special value of 0 turn off threaded I/O and enables the blocking
|
267
|
-
# Virtual Memory implementation.
|
268
31
|
vm-max-threads 4
|
269
32
|
|
270
|
-
|
33
|
+
hash-max-zipmap-entries 512
|
34
|
+
hash-max-zipmap-value 64
|
271
35
|
|
272
|
-
|
273
|
-
|
274
|
-
# in terms of number of queries per second. Use 'yes' if unsure.
|
275
|
-
glueoutputbuf yes
|
36
|
+
list-max-ziplist-entries 512
|
37
|
+
list-max-ziplist-value 64
|
276
38
|
|
277
|
-
|
278
|
-
# have at max a given numer of elements, and the biggest element does not
|
279
|
-
# exceed a given threshold. You can configure this limits with the following
|
280
|
-
# configuration directives.
|
281
|
-
hash-max-zipmap-entries 64
|
282
|
-
hash-max-zipmap-value 512
|
39
|
+
set-max-intset-entries 512
|
283
40
|
|
284
|
-
# Active rehashing uses 1 millisecond every 100 milliseconds of CPU time in
|
285
|
-
# order to help rehashing the main Redis hash table (the one mapping top-level
|
286
|
-
# keys to values). The hash table implementation redis uses (see dict.c)
|
287
|
-
# performs a lazy rehashing: the more operation you run into an hash table
|
288
|
-
# that is rhashing, the more rehashing "steps" are performed, so if the
|
289
|
-
# server is idle the rehashing is never complete and some more memory is used
|
290
|
-
# by the hash table.
|
291
|
-
#
|
292
|
-
# The default is to use this millisecond 10 times every second in order to
|
293
|
-
# active rehashing the main dictionaries, freeing memory when possible.
|
294
|
-
#
|
295
|
-
# If unsure:
|
296
|
-
# use "activerehashing no" if you have hard latency requirements and it is
|
297
|
-
# not a good thing in your environment that Redis can reply form time to time
|
298
|
-
# to queries with 2 milliseconds delay.
|
299
|
-
#
|
300
|
-
# use "activerehashing yes" if you don't have such hard requirements but
|
301
|
-
# want to free memory asap when possible.
|
302
41
|
activerehashing yes
|
303
42
|
|
304
|
-
################################## INCLUDES ###################################
|
305
|
-
|
306
|
-
# Include one or more other config files here. This is useful if you
|
307
|
-
# have a standard template that goes to all redis server but also need
|
308
|
-
# to customize a few per-server settings. Include files can include
|
309
|
-
# other files, so use this wisely.
|
310
|
-
#
|
311
|
-
# include /path/to/local.conf
|
312
|
-
# include /path/to/other.conf
|