クラス: Mongo::Socket Private

継承:

オブジェクト

オブジェクト
Mongo::Socket

すべて表示

次のことが含まれます。: Socket::Constances

定義:: lib/mongo/socket.rb
、lib/mongo/socket/ssl.rb、lib/mongo/socket/tcp.rb、lib/mongo/socket/unix.rb、lib/mongo/socket/OCSP_cache.rb、lib/

mongo/socket/OCSP_verifier.rb

Overview

このクラスは、プライベート API の一部です。 このクラスは将来削除または変更される可能性があるため、可能な限り使用しないでください。

ドライバーの使用のためにソケットに関する追加データを提供します。

以来

2.0.0

既知のサブクラスを直接確認

SSL, TCP, Unix

名前空間で定義済み

Modules: OcspCache クラス: OcspVerifier, SSL, TCP, Unix

定数の概要の削減

SSL_ERROR =

この定数は、プライベート API の一部です。 この定数は将来削除または変更される可能性があるため、可能な限り使用しないでください。

非推奨。

TLS 関連の例外のエラーメッセージ。

以来

2.0.0

「 MongoDB は TLS サポートで構成されていない」.freeze

OUTTIME_ERROR =

この定数は、プライベート API の一部です。 この定数は将来削除または変更される可能性があるため、可能な限り使用しないでください。

非推奨。

ソケット呼び出しのタイムアウトに関するエラーメッセージ。

以来

2.0.0

'ソケット リクエストがタイムアウトしました'.freeze

OUTTIME_PACK =

この定数は、プライベート API の一部です。 この定数は将来削除または変更される可能性があるため、可能な限り使用しないでください。

タイムアウト用のパッケージディレクティブ。

以来

2.0.0

'l_2'.freeze

WRITE_CHARK_SIZE =

この定数は、プライベート API の一部です。 この定数は将来削除または変更される可能性があるため、可能な限り使用しないでください。

このサイズのチャンクでソケットにデータを書込みます。

以来

2.0.0

インスタンス属性の概要を折りたたむ

#ファミリー～整数 readOnly private

ファミリーホストファミリーのタイプ。
#options ⇒ Hash readOnly private

オプション。
#socket ⇒ Socket readOnly private

Socket ラップされたソケット。
#タイムアウト= 浮動小数点数 readOnly private

Timeout ソケットのタイムアウト。

インスタンスメソッドの概要を折りたたむ

#ライブ= true、false 非推奨 private 非推奨。

#connectable を使用するかどうかください。
#閉じる= true private

ソケットを閉じます。
#接続可能かどうか = true 非推奨 private 非推奨。
# connection_address → アドレス private

このソケットを作成した接続のアドレス。
# connection_generation = 整数 private

このソケットを作成した接続の生成（非モニタリング接続の場合）。
#eof? ⇒ Boolean private

このソケットが EOF に達しているかどうかをテストします。
が(*args) = オブジェクト private

取得を基礎となるソケットに委任します。
#初期化（タイムアウト、オプション） = ソケットコンストラクター private

一般的なソケット属性を初期化します。
#モニター? = true | false private

このソケットはモニタリング接続によって作成されたかどうか。
#pipe ⇒ IO private

listen on during the select system call when reading from the socket.
#read (Length、 socket_timeout: nil、timeout: nil) = オブジェクト private

指定されたバイト数のソケットからすべてのデータを読み取ります。
#readbyte =オブジェクト private

ソケットから 1 バイトを読み取ります。
#のサマリー= string private

デバッグ用ソケットの人間が判読可能な概要。
#write (*args、タイムアウト: nil) = 整数 private

ソケットインスタンスにデータを書込みます。

コンストラクターの詳細

#初期化（タイムアウト、オプション） =`ソケット`

このメソッドは、プライベート API の一部です。 このメソッドは将来削除または変更される可能性があるため、可能な限り使用しないでください。

一般的なソケット属性を初期化します。

パラメーター:

タイムアウト（浮動小数） —

ソケットタイムアウト値。
options （ハッシュ） —

オプション。

オプションハッシュ（ options ）:

:connect_timeout （浮動小数） —

接続タイムアウト。
: connection_address （アドレス） —

このソケットを作成した接続のアドレス。
: connection_生成（整数） —

このソケットを作成した接続の生成（非モニタリング接続の場合）。
:mongos （ true | false ） —

このソケットはモニタリング接続によって作成されたかどうか。
: パイプ (IO) —

ソケットから読み取るときに選択システム呼び出し中にリッスンするパイプの読み取りエンドのファイル記述子。

以来

2.0.0

# ファイル 'lib/mongo/socket.rb', 行 72

デフォルト 初期化(タイムアウト, options)
  @timeout = タイムアウト
  @options = options
end

インスタンス属性の詳細

#ファミリー～`整数`（読み取り専用）

ホストファミリーのタイプを返します。

次の値を返します。

(整数) —

ホストファミリーのタイプ。

以来

2.0.0



78
79
80

# ファイル 'lib/mongo/socket.rb', 行 78

デフォルト ファミリー
  @ファミリー
end

オプション=`ハッシュ`（読み取り専用）

オプションを返します。

次の値を返します。

（ハッシュ） —

オプション。

以来

2.0.0



84
85
86

# ファイル 'lib/mongo/socket.rb', 行 84

デフォルト options
  @options
end

#storage:ソケット=`ソケット`（読み取り専用）

ラップされたソケットを返します。

次の値を返します。

（ソケット） —

socket をラップしたソケット。

以来

2.0.0



81
82
83

# ファイル 'lib/mongo/socket.rb', 行 81

デフォルト ソケット
  @socket
end

#タイムアウト=`浮動小数点`数(読み取り専用)

timeout ソケットタイムアウトを返します。

次の値を返します。

（浮動小数） —

timeout ソケットタイムアウト。

以来

2.0.0



87
88
89

# ファイル 'lib/mongo/socket.rb', 行 87

デフォルト タイムアウト
  @timeout
end

インスタンスメソッドの詳細

#ライブ= `true` 、 `false`

非推奨。

#connectable を使用するかどうかください。

ソケット接続は有効かどうか。

例:

ソケットは有効かどうか。

socket.alive?

次の値を返します。

（ true 、 false ） —

ソケットがアクティブな場合。

以来

2.0.0

# ファイル 'lib/mongo/socket.rb', 行 144

デフォルト alive?
  socket_arr = [ @socket ]
  場合 Kernel::選択する(socket_arr, nil, socket_arr, 0)
    番号 の合計は？呼び出しは を選択したためすぐに返されるはずです
    # はソケットが読み取り可能であることを示します。 ただし、@socket が TLS の場合
    # ソケット、E、またはは任意のブロックが可能です - Ruby- 2140を参照してください。
    begin
      タイムアウト.タイムアウト(0.1) 行う
        の
      end
    ヘルプ ::タイムアウト::エラー
      true
    end
  else
    true
  end
end

#閉じる= `true`

ソケットを閉じます。

例:

ソケットを閉じます。

socket.close

次の値を返します。

( true ) —

常に true

以来

2.0.0

# ファイル 'lib/mongo/socket.rb', 行 170

デフォルト 閉じる
  begin
    # 場合によっては、Close 呼び出しが長時間ハングしているように見えます
    ::タイムアウト.タイムアウト(5) 行う
      @socket&.閉じる
    end
  ヘルプ
    # すべてのエラーを無視
  end
  true
end

#接続可能かどうか = `true`

非推奨。

下位互換性のみ、は使用しないでください。

次の値を返します。

( true ) —

常に true

以来

2.0.0



270
271
272

# ファイル 'lib/mongo/socket.rb', 行 270

デフォルト 接続可能かどうか
  true
end

# connection_address →`アドレス`

このソケットを作成した接続のアドレスを返します。

次の値を返します。

（アドレス） —

このソケットを作成した接続のアドレス。

以来

2.0.0



92
93
94

# ファイル 'lib/mongo/socket.rb', 行 92

デフォルト connection_address
  options[: connection_address]
end

# connection_generation =`整数`

このソケットを作成した接続の生成（非モニタリング接続の場合）を返します。

次の値を返します。

(整数) —

このソケットを作成した接続の生成（非モニタリング接続の場合）。

以来

2.0.0



100
101
102

# ファイル 'lib/mongo/socket.rb', 行 100

デフォルト connection_生成
  options[: connection_生成]
end

#eof? ⇒ `Boolean`

このソケットが EOF に達しているかどうかをテストします。主にライブ確認に使用されます。

次の値を返します。

（ブール値）

以来

2.0.5

# ファイル 'lib/mongo/socket.rb', 行 259

デフォルト の
  @socket.の
ヘルプ IOError, SystemCallError
  true
end

が(*args) =`オブジェクト`

取得を基礎となるソケットに委任します。

例:

次の行を取得します。

socket.gets(10)

パラメーター:

args （配列<Object> ） —

渡す引数。

次の値を返します。

（オブジェクト） —

返されたバイト。

以来

2.0.0

# ファイル 'lib/mongo/socket.rb', 行 192

デフォルト 取得(*args)
  map_例外 行う
    @socket.取得(*args)
  end
end

#モニター? = `true | false`

このソケットはモニタリング接続によって作成されたかどうかを返します。

次の値を返します。

（ true | false ） —

このソケットはモニタリング接続によって作成されたかどうか。

以来

2.0.0



108
109
110

# ファイル 'lib/mongo/socket.rb', 行 108

デフォルト 監視しますか？
  !!options[:mongos]
end

#pipe ⇒ `IO`

listen on during the select system call when reading from the socket.

次の値を返します。

(IO) —

The file descriptor for the read end of the pipe to

以来

2.0.0



115
116
117

# ファイル 'lib/mongo/socket.rb', 行 115

デフォルト パイプ
  options[: パイプ]
end

#read (Length、 socket_timeout: nil、timeout: nil) = `オブジェクト`

指定されたバイト数のソケットからすべてのデータを読み取ります。データが返されない場合は、例外が発生します。

例:

ソケットから要求されたすべてのデータを読み取ります。

socket.read(4096)

パラメーター:

Length (整数) —

読み込むバイト数。
socket_timeout （数値） （デフォルトはnil ） —

各チャンクの読み取りに使用するタイムアウト。timeoutと相互に排他的です。
タイムアウト（数値） （デフォルトはnil ） —

読み取り操作全体の合計タイムアウトで、socket_timeout と相互に排他的です。

次の値を返します。

（オブジェクト） —

ソケットからのデータ。

次の値が発生します。

（ Mongo::SocketError ） —

すべてのデータが返されない場合。

以来

2.0.0

# ファイル 'lib/mongo/socket.rb', 行 215

デフォルト 読み取り(Length, socket_timeout: nil, timeout: nil)
  場合 !socket_timeout.nil? & & !タイムアウト.nil?
    発生 ArgumentError, ' タイムアウトと socket_timeout の両方を設定することはできません '
  end
  場合 !socket_timeout.nil? || タイムアウト.nil?
    read_Without_timeout(Length, socket_timeout)
  else
    read_with_timeout(Length, タイムアウト)
  end
end

#readbyte =`オブジェクト`

ソケットから 1 バイトを読み取ります。

例:

単一バイトを読み取ります。

socket.readbyte

次の値を返します。

（オブジェクト） —

読み取りバイト。

以来

2.0.0

# ファイル 'lib/mongo/socket.rb', 行 234

デフォルト 読み取りバイト
  map_例外 行う
    @socket.読み取りバイト
  end
end

#のサマリー= `string`

デバッグ用にソケットの人間が判読可能な概要を返します。

次の値を返します。

( string ) —

デバッグ用ソケットの人間が判読可能な概要。

以来

2.0.0

# ファイル 'lib/mongo/socket.rb', 行 122

デフォルト 概要
  fileno = @socket&.fileno ヘルプ '<no socket>' || '<no socket>'
  場合 監視しますか？
    インジケーター = 場合 options[:push]
      'pm'
    else
      'm'
    end
    " "
  else
    " "
  end
end

#write (*args、タイムアウト: nil) = `整数`

ソケットインスタンスにデータを書込みます。

パラメーター:

args （配列<Object> ） —

書き込まれるデータ。
タイムアウト（数値） （デフォルトはnil ） —

書込み (write)操作全体の合計タイムアウト。

次の値を返します。

(整数) —

ソケットに書込まれたバイトの長さ。

次の値が発生します。

(Error::SocketError | Error::SocketTimeoutError) —

書き込み中にネットワークエラーが発生した場合。

以来

2.0.0

# ファイル 'lib/mongo/socket.rb', 行 250

デフォルト 書込み (write)(*args, timeout: nil)
  map_例外 行う
    do_write(*args, timeout: タイムアウト)
  end
end

クラス: Mongo::Socket Private

Overview

既知のサブクラスを直接確認

名前空間で定義済み

定数の概要の削減

インスタンス属性の概要を折りたたむ

インスタンス メソッドの概要を折りたたむ

コンストラクターの詳細

#初期化（タイムアウト、オプション） =ソケット

インスタンス属性の詳細

#ファミリー～整数（読み取り専用）

オプション=ハッシュ（読み取り専用）

#storage:ソケット=ソケット（読み取り専用）

#タイムアウト=浮動小数点数(読み取り専用)

インスタンス メソッドの詳細

#ライブ= true 、 false

例:

ソケットは有効かどうか。

#閉じる= true

例:

ソケットを閉じます。

#接続可能かどうか = true

# connection_address →アドレス

# connection_generation =整数

#eof? ⇒ Boolean

が(*args) =オブジェクト

例:

次の行を取得します。

#モニター? = true | false

#pipe ⇒ IO

#read (Length、 socket_timeout: nil、timeout: nil) = オブジェクト

例:

ソケットから要求されたすべてのデータを読み取ります。

#readbyte =オブジェクト

例:

単一バイトを読み取ります。

#のサマリー= string

#write (*args、タイムアウト: nil) = 整数

インスタンスメソッドの概要を折りたたむ

#初期化（タイムアウト、オプション） =`ソケット`

#ファミリー～`整数`（読み取り専用）

オプション=`ハッシュ`（読み取り専用）

#storage:ソケット=`ソケット`（読み取り専用）

#タイムアウト=`浮動小数点`数(読み取り専用)

インスタンスメソッドの詳細

#ライブ= `true` 、 `false`

#閉じる= `true`

#接続可能かどうか = `true`

# connection_address →`アドレス`

# connection_generation =`整数`

#eof? ⇒ `Boolean`

が(*args) =`オブジェクト`

#モニター? = `true | false`

#pipe ⇒ `IO`

#read (Length、 socket_timeout: nil、timeout: nil) = `オブジェクト`

#readbyte =`オブジェクト`

#のサマリー= `string`

#write (*args、タイムアウト: nil) = `整数`