クラス: Mongo::Crypt::KmsContext

継承:
オブジェクト
  • オブジェクト
すべて表示
定義:
lib/mongo/crypt/ kms_context.rb

Overview

libmongocrypt mongocrypt_ kms_ctx_t オブジェクト をラップします。 KMS データ キーに関する情報を取得するための HTTP リクエストの実行に関する情報が含まれています。

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

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

コンストラクターの詳細

#initialize(kms_ctx) ⇒ KmsContext

新しい KmsContext オブジェクトを作成します。

パラメーター:

  • kms_ctx （ FFI ::Pointer ） —

    mongocrypt_ kms_ctx_t オブジェクトへのポインター。 このオブジェクトは、それを作成した mongocrypt_ctx_t オブジェクトによって管理されます。このクラスは、リソースの割り当て解除を担当するものではありません。



28
29
30
 
# ファイル 'lib/mongo/crypt/ kms_context.rb' は、28 行

デフォルト 初期化(kms_ctx)
  @kms_ctx_p = kms_ctx
end

インスタンス属性の詳細

# kms_ctx_p → FFI::Pointer （読み取り専用）

基礎となる mongocrypt_ kms_ctx_t オブジェクトへのポインターを返します。

次の値を返します。

  • （ FFI ::Pointer ） —

    mongocrypt_ kms_ctx_t オブジェクトへのポインター。



35
36
37
 
# ファイル 'lib/mongo/crypt/ kms_context.rb' は、35 行

デフォルト kms_ctx_p
  @kms_ctx_p
end

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

# bytes_needed =整数

Amazon Web Servicesデータキーに関する情報のリクエストを完了するために libmongocrypt がまだ必要とするバイト数を返します。

次の値を返します。

  • (整数) —

    必要なバイト数。



56
57
58
 
# ファイル 'lib/mongo/crypt/ kms_context.rb' は、56 行

デフォルト bytes_needed
  バインディング.kms_ctx_bytes_needed(自己)
end

#エンドポイント= string

HTTP リクエストを行うエンドポイントを返します。

次の値を返します。

  • ( string ) —

    エンドポイント。



40
41
42
 
# ファイル 'lib/mongo/crypt/ kms_context.rb' は、40 行

デフォルト エンドポイント
  バインディング.kms_ctx_endpoint(自己)
end

#フィード（データ） =オブジェクト

libmongocrypt への HTTP リクエストからの応答を提供します。

パラメーター:

  • データ ( string ) —

    libmongocrypt に入力するデータ。



63
64
65
 
# ファイル 'lib/mongo/crypt/ kms_context.rb' は、63 行

デフォルト フィード(データ)
  バインディング.kms_ctx_feed(自己, データ)
end

#メッセージ= string

関連する KMS データキーに関する情報を取得するために送信する HTTP メッセージを返します。

次の値を返します。

  • ( string ) —

    The HTTP message.



48
49
50
 
# ファイル 'lib/mongo/crypt/ kms_context.rb' は、48 行

デフォルト メッセージ
  バインディング.kms_ctx_message(自己)
end