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
|
# Copyright (C) 2014-2017 MongoDB, 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.
module Mongo
class Socket
# Wrapper for Unix sockets.
#
# @since 2.0.0
class Unix < Socket
# @return [ String ] path The path to connect to.
attr_reader :path
# @return [ Float ] timeout The socket timeout.
attr_reader :timeout
# Establishes a socket connection.
#
# @example Connect the socket.
# sock.connect!
#
# @note This method mutates the object by setting the socket
# internally.
#
# @return [ Unix ] The connected socket instance.
#
# @since 2.0.0
def connect!(connect_timeout = nil)
self
end
# Initializes a new Unix socket.
#
# @example Create the Unix socket.
# Unix.new('/path/to.sock', 5)
#
# @param [ String ] path The path.
# @param [ Float ] timeout The socket timeout value.
#
# @since 2.0.0
def initialize(path, timeout)
@path, @timeout = path, timeout
@socket = ::UNIXSocket.new(path)
set_socket_options(@socket)
end
# This socket can only be used if the unix socket (@socket) has been created.
#
# @example Is the socket connectable?
# socket.connectable?
#
# @return [ true, false ] If the socket is connectable.
#
# @since 2.2.5
def connectable?
!!@socket
end
end
end
end
|
