123456789_123456789_123456789_123456789_123456789_

Class: Mongo::Socket::Unix Private

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
Instance Chain:
self, ::Mongo::Socket, Socket::Constants
Inherits: Mongo::Socket
Defined in: lib/mongo/socket/unix.rb

Overview

Wrapper for Unix sockets.

Since:

  • 2.0.0

Constant Summary

::Mongo::Socket - Inherited

DEFAULT_TCP_KEEPCNT, DEFAULT_TCP_KEEPIDLE, DEFAULT_TCP_KEEPINTVL, DEFAULT_TCP_USER_TIMEOUT, SSL_ERROR, TIMEOUT_ERROR, TIMEOUT_PACK, WRITE_CHUNK_SIZE

Class Method Summary

::Mongo::Socket - Inherited

.new

Initializes common socket attributes.

Instance Attribute Summary

::Mongo::Socket - Inherited

#alive?

Is the socket connection alive?

#connectable?

For backwards compatibility only, do not use.

#eof?

Tests if this socket has reached EOF.

#family, #monitor?, #options, #socket, #timeout

Instance Method Summary

::Mongo::Socket - Inherited

#close

Close the socket.

#connection_address, #connection_generation,
#gets

Delegates gets to the underlying socket.

#read

Will read all data from the socket for the provided number of bytes.

#readbyte

Read a single byte from the socket.

#summary,
#write

Writes data to the socket instance.

#allocate_string,
#do_write

Writes data to the socket instance.

#human_address, #map_exceptions, #raise_timeout_error!, #read_buffer_size,
#read_from_socket

Reads the length bytes from the socket.

#read_with_timeout

Reads the length bytes from the socket, the read operation duration is limited to #timeout second.

#read_without_timeout

Reads the length bytes from the socket.

#set_keepalive_opts, #set_option, #set_socket_options, #unix_socket?, #write_chunk,
#write_with_timeout

Writes data to to the socket, the write duration is limited to #timeout.

#write_without_timeout

Writes data to to the socket.

Instance Attribute Details

#pathString (readonly)

Returns:

  • (String)

    path The path to connect to.

Since:

  • 2.0.0

[ GitHub ]

  
# File 'lib/mongo/socket/unix.rb', line 53

attr_reader :path

Instance Method Details

#human_address (private)

Since:

  • 2.0.0

[ GitHub ]

  
# File 'lib/mongo/socket/unix.rb', line 57

def human_address
  path
end