Ruby 2.7.0 リファレンスマニュアル > ライブラリ一覧 > socketライブラリ > Socket::AncillaryDataクラス

class Socket::AncillaryData

クラス・モジュールの継承リスト: Socket::AncillaryData < Object < Kernel < BasicObject

要約

BasicSocket#sendmsgBasicSocket#recvmsg で用いる ancillary data (補助データ、制御情報) を表すクラスです。

Socket::AncillaryData#family(socket family), Socket::AncillaryData#level(cmsg level), Socket::AncillaryData#type(cmsg type), Socket::AncillaryData#data(cmsg data), といった要素を持ちます。

特異メソッド

定義 説明
int(family, cmsg_level, cmsg_type, integer) -> Socket::AncillaryData

データとして整数を保持する Socket::AncillaryData オブジェクトを生成します。

ip_pktinfo(addr, ifindex, spec_dst=addr) -> Socket::AncillaryData

type が IP_PKTINFO である AncillaryData を生成します。

ipv6_pktinfo(addr, ifindex) -> Socket::AncillaryData

type が IPV6_PKTINFO である AncillaryData を生成します。

new(family, cmsg_level, cmsg_type, cmsg_data) -> Socket::AncillaryData

新たな Socket::AncillaryData オブジェクトを生成します。

unix_rights(*ios) -> Socket::AncillaryData

ios で指定したファイルのファイルデスクリプタをデータとして持つ family=AF_UNIX, level=SOL_SOCKET, type=SCM_RIGHTS という Socket::AncillaryData オブジェクトを生成して返します。

インスタンスメソッド

定義 説明
cmsg_is?(level, type) -> bool

自身の level と type が引数のものと一致している場合に真を返します。

data -> String

自身が保持している cmsg data (データ) を返します。

family -> Integer

自身が保持している socket family を返します。

int -> Integer

自身が保持している cmsg data (データ) を整数の形で返します。

ip_pktinfo -> [Addrinfo, Integer, Addrinfo]

自身の type が IP_PKTINFO である場合、保持しているデータ (アドレス、インターフェースのインデックス、ローカルアドレス) を3要素の配列で返します。

ipv6_pktinfo -> [Addrinfo, Integer]

自身の type が IPV6_PKTINFO である場合、保持しているデータ (アドレス、インターフェースのインデックス) を2要素の配列で返します。

ipv6_pktinfo_addr -> Addrinfo

自身の type が IPV6_PKTINFO である場合、保持しているデータ (アドレス、インターフェースのインデックス) のアドレスを返します。

ipv6_pktinfo_ifindex -> Integer

自身の type が IPV6_PKTINFO である場合、保持しているデータ (アドレス、インターフェースのインデックス) のインデックスを返します。

level -> Integer

自身が保持している cmsg level (元プロトコル) を返します。

timestamp -> Time

タイムスタンプ制御メッセージに含まれる時刻を Time オブジェクトで返します。

type -> Integer

自身が保持している cmsg type (種類) を返します。

unix_rights -> [IO] | nil

Unix domain socket の SCM_RIGHTS 制御メッセージに含まれるファイルディスクリプタを IO オブジェクトの配列として返します。

継承したメソッド

! != __id__ __send__ instance_eval instance_exec method_missing singleton_method_added singleton_method_removed singleton_method_undefined !~ <=> == === =~ _dump class clone define_singleton_method display enum_for eql? equal? extend freeze frozen? hash initialize initialize_copy inspect instance_of? instance_variable_defined? instance_variable_get instance_variable_set instance_variables is_a? itself marshal_dump marshal_load method methods nil? object_id pretty_inspect pretty_print pretty_print_cycle pretty_print_inspect pretty_print_instance_variables private_methods protected_methods psych_to_yaml public_method public_methods public_send remove_instance_variable respond_to? respond_to_missing? send singleton_class singleton_method singleton_methods taint tainted? tap then to_a to_ary to_hash to_int to_io to_proc to_regexp to_s to_str trust untaint untrust untrusted? .yaml_tag ::ARGF ::ARGV ::DATA ::ENV ::FALSE ::NIL ::RUBY_COPYRIGHT ::RUBY_DESCRIPTION ::RUBY_ENGINE ::RUBY_ENGINE_VERSION ::RUBY_PATCHLEVEL ::RUBY_PLATFORM ::RUBY_RELEASE_DATE ::RUBY_REVISION ::RUBY_VERSION ::SCRIPT_LINES__ ::STDERR ::STDIN ::STDOUT ::TOPLEVEL_BINDING ::TRUE