Class: BasicSocket

Inherits:
IO
  • Object
show all
Defined in:
lib/rubysl/socket.rb

Direct Known Subclasses

IPSocket, Socket, UNIXSocket

Constant Summary collapse

FFI = 
Rubinius::FFI

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.do_not_reverse_lookup ⇒ Object 



33
34
35
36
 
# File 'lib/rubysl/socket.rb', line 33

def self.do_not_reverse_lookup
  @no_reverse_lookup = true unless defined? @no_reverse_lookup
  @no_reverse_lookup
end

.do_not_reverse_lookup=(setting) ⇒ Object 



29
30
31
 
# File 'lib/rubysl/socket.rb', line 29

def self.do_not_reverse_lookup=(setting)
  @no_reverse_lookup = setting
end

.for_fd ⇒ Object 



21
22
23
24
25
 
# File 'lib/rubysl/socket.rb', line 21

def from_descriptor(fixnum)
  sock = allocate()
  sock.from_descriptor(fixnum)
  return sock
end

.from_descriptor(fixnum) ⇒ Object 



15
16
17
18
19
 
# File 'lib/rubysl/socket.rb', line 15

def from_descriptor(fixnum)
  sock = allocate()
  sock.from_descriptor(fixnum)
  return sock
end

Instance Method Details

#close_read ⇒ Object 



149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/rubysl/socket.rb', line 149

def close_read
  ensure_open

  # If we were only in readonly mode, close it all together
  if @mode & ACCMODE == RDONLY
    return close
  end

  # MRI doesn't check if shutdown worked, so we don't.
  Socket::Foreign.shutdown @descriptor, 0

  @mode = WRONLY

  nil
end

#close_write ⇒ Object 



165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
 
# File 'lib/rubysl/socket.rb', line 165

def close_write
  ensure_open

  # If we were only in writeonly mode, close it all together
  if @mode & ACCMODE == WRONLY
    return close
  end

  Socket::Foreign.shutdown @descriptor, 1

  # Mark it as read only
  @mode = RDONLY

  nil
end

#do_not_reverse_lookup ⇒ Object 



42
43
44
 
# File 'lib/rubysl/socket.rb', line 42

def do_not_reverse_lookup
  @no_reverse_lookup
end

#do_not_reverse_lookup=(setting) ⇒ Object 



38
39
40
 
# File 'lib/rubysl/socket.rb', line 38

def do_not_reverse_lookup=(setting)
  @no_reverse_lookup = setting
end

#from_descriptor(fixnum) ⇒ Object 



24
25
26
27
 
# File 'lib/rubysl/socket.rb', line 24

def from_descriptor(fixnum)
  IO.setup self, fixnum, nil, true
  return self
end

#getpeername ⇒ Object

Obtain peername information for this socket.

See Also:



117
118
119
 
# File 'lib/rubysl/socket.rb', line 117

def getpeername()
  Socket::Foreign.getpeername @descriptor
end

#getsockname ⇒ Object 



108
109
110
 
# File 'lib/rubysl/socket.rb', line 108

def getsockname()
  return Socket::Foreign.getsockname(descriptor)
end

#getsockopt(level, optname) ⇒ Object 



46
47
48
49
50
51
52
 
# File 'lib/rubysl/socket.rb', line 46

def getsockopt(level, optname)
  data = Socket::Foreign.getsockopt(descriptor, level, optname)

  sockaddr = Socket::Foreign.getsockname(descriptor)
  family, = Socket::Foreign.getnameinfo sockaddr, Socket::Constants::NI_NUMERICHOST | Socket::Constants::NI_NUMERICSERV
  Socket::Option.new(family, level, optname, data)
end

#recv(bytes_to_read, flags = 0) ⇒ Object 



144
145
146
147
 
# File 'lib/rubysl/socket.rb', line 144

def recv(bytes_to_read, flags = 0)
  # FIXME 0 is knowledge from io.cpp
  return socket_recv(bytes_to_read, flags, 0)
end

#recv_nonblock(bytes_to_read, flags = 0) ⇒ Object

TODO:

Should EWOULDBLOCK be passed unchanged? –rue

Sets socket nonblocking and reads up to given number of bytes.



186
187
188
189
190
191
 
# File 'lib/rubysl/socket.rb', line 186

def recv_nonblock(bytes_to_read, flags = 0)
  fcntl Fcntl::F_SETFL, Fcntl::O_NONBLOCK
  socket_recv bytes_to_read, flags, 0
rescue Errno::EWOULDBLOCK
  raise Errno::EAGAIN
end

#recvfrom(bytes_to_read, flags = 0) ⇒ Object 



139
140
141
142
 
# File 'lib/rubysl/socket.rb', line 139

def recvfrom(bytes_to_read, flags = 0)
  # FIXME 0 is knowledge from io.cpp
  return socket_recv(bytes_to_read, flags, 0)
end

#send(message, flags, to = nil) ⇒ Object 



124
125
126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/rubysl/socket.rb', line 124

def send(message, flags, to = nil)
  connect to if to

  bytes = message.bytesize
  bytes_sent = 0

  FFI::MemoryPointer.new :char, bytes + 1 do |buffer|
    buffer.write_string message, bytes
    bytes_sent = Socket::Foreign.send(descriptor, buffer, bytes, flags)
    Errno.handle 'send(2)' if bytes_sent < 0
  end

  bytes_sent
end

#setsockopt(level_or_option, optname = nil, optval = nil) ⇒ Object 



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
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/rubysl/socket.rb', line 54

def setsockopt(level_or_option, optname=nil, optval=nil)
  level = nil

  case level_or_option
  when Socket::Option
    if !optname.nil?
      raise ArgumentError, "given 2, expected 3"
    end
    level = level_or_option.level
    optname = level_or_option.optname
    optval = level_or_option.data
  else
    if level_or_option.nil? or optname.nil?
      nb_arg = 3 - [level_or_option, optname, optval].count(nil)
      raise ArgumentError, "given #{nb_arg}, expected 3"
    end
    level = level_or_option
  end

  optval = 1 if optval == true
  optval = 0 if optval == false

  error = 0

  sockname = Socket::Foreign.getsockname descriptor
  family = Socket::Foreign.getnameinfo(sockname).first

  level = level_arg(family, level)
  optname = optname_arg(level, optname)

  case optval
  when Fixnum then
    FFI::MemoryPointer.new :socklen_t do |val|
      val.write_int optval
      error = Socket::Foreign.setsockopt(descriptor, level,
                                         optname, val,
                                         val.total)
    end
  when String then
    FFI::MemoryPointer.new optval.bytesize do |val|
      val.write_string optval, optval.bytesize
      error = Socket::Foreign.setsockopt(descriptor, level,
                                         optname, val,
                                         optval.size)
    end
  else
    raise TypeError, "socket option should be a String, a Fixnum, true, or false"
  end

  Errno.handle "Unable to set socket option" unless error == 0

  return 0
end

#shutdown(how = 2) ⇒ Object 



193
194
195
196
 
# File 'lib/rubysl/socket.rb', line 193

def shutdown(how = 2)
  err = Socket::Foreign.shutdown @descriptor, how
  Errno.handle "shutdown" unless err == 0
end