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

class Socket

クラスの継承リスト: Socket < BasicSocket < IO < Enumerable < File::Constants < Object < Kernel < BasicObject

Abstract

特異メソッド

getaddrinfo(nodename, servname[, family[, socktype[, protocol[, flags]]]])

[RFC2553]で定義された getaddrinfo() の機能を提供するクラスメソッド。この関数は gethostbyname() や getservbyname() の代わりとして用意されており、 IP のバージョンに依存しないプログラムを書くための標準的な API です。

アドレス情報の配列を返します。アドレス情報とは7つの要素からなる次の 形の配列です。

• 第0要素 - アドレスファミリー (String)
• 第1要素 - ポート番号 (Integer)
• 第2要素 - ホスト名 (String)
• 第3要素 - アドレス (String)
• 第4要素 - アドレスファミリーに対応する Integer
• 第5要素 - ソケットタイプに対応する Integer
• 第6要素 - プロトコルに対応する Integer

必須引数の意味は以下の通りです。

• nodename - ホスト名 ([[m:socket#ホスト指定形式]]を参照)
• servname - サービス名 ([[m:socket#サービス指定形式]]を参照)

残りの引数は省略可能です。

• family - アドレスファミリー。 Socket::AF_INET など、 [[m:Socket::Constants#アドレスファミリー]]にある定数を指定します。
• socktype - ソケットタイプ。 Socket::SOCK_STREAM など、 [[m:Socket::Constants#ソケットタイプ]]にある定数を指定します。
• protocol - プロトコル。 Socket::IPPROTO_IP など、 [[m:Socket::Constants#プロトコル]]にある定数を指定します。
• flags - getaddrinfo(3) の第3引数に指定する addrinfo 構造体の ai_flags メンバに相当する Fixnum。 Socket::AI_PASSIVE、 Socket::AI_CANONNAME、 Socket::AI_NUMERICHOST が用意されている場合があります。

引数に指定できる定数の意味については getaddrinfo(3) を参照して下さい。

例:

p Socket.getaddrinfo(Socket.gethostname, "ftp")
#=> [["AF_INET", 21, "helium.ruby-lang.org", "210.251.121.214", 2, 1, 6]]

pp Socket.getaddrinfo(Socket.gethostname, nil)
#=> [["AF_INET", 0, "helium.ruby-lang.org", "210.251.121.214", 2, 1, 6],
#    ["AF_INET", 0, "helium.ruby-lang.org", "210.251.121.214", 2, 2, 17],
#    ["AF_INET", 0, "helium.ruby-lang.org", "210.251.121.214", 2, 3, 0]]

gethostbyaddr(host[, type])

sockaddr 構造体をパックした文字列からホスト情報を返します。 ホスト情報の構造は Socket.gethostbyname と同じです。 type には、アドレスタイプ(デフォルトは Socket::AF_INET)を指定します。

gethostbyname(host)

ホスト名または IP アドレス(指定方法に関しては [[m:socket#ホスト指定形式]]を参照) からホストの情報を返します。 ホスト情報は以下の 4 要素の配列で表現されています。

• ホスト名
• ホストの別名の配列
• ホストのアドレスタイプ (整数定数)
• ホストのアドレス

第四要素のホストのアドレスは、各アドレスタイプに対応する C のアドレス構造体を pack した文字列として表現されています。 例えばアドレスタイプが AF_INET (定数 2) ならば Socket.unpack_sockaddr_in で unpack できます。

例:

irb(main):009:0> Socket.gethostbyname("210.251.121.214")
["helium.ruby-lang.org", ["helium"], 2, "\322\373y\326"]

irb(main):009:0> Socket.unpack_sockaddr_in(Socket.gethostbyname("210.251.121.214")[3])[1]
"210.251.121.214"

gethostname

システムの標準のホスト名を取得します。

ホストの別名やアドレスなど他の情報を得るには Socket.getaddrinfo を使ってください。 ただし、これは不可能な場合もあります。

例:

p Socket.gethostname   #=> "helium.ruby-lang.org"

getnameinfo(sa[, flags])

[RFC2553] で定義された getnameinfo() の機能を提供するク ラスメソッド。 gethostbyaddr() や getservbyport() の代 わりとして用意されています。IPのバージョンに依存しないプログラムを 書くための標準的なAPIです。

配列を返し、その要素はアドレスとポートを表す文字列です。

引数 sa には文字列か配列を与えます。文字列の場合は sockaddr 構造体 のパック文字列を与えます。具体的には BasicSocket#getsockname の値が利用できます。配列を与える場合には、要素が3つの場合と4つの場合 があります。

• 要素が3つの場合: [アドレスファミリー, サービス, ホスト]
• 要素が4つの場合: [アドレスファミリー, サービス, 任意, アドレスを表す文字列]

アドレスファミリーには Socket::AF_INET 等の定数の他に文字列 で "AF_INET" もしくは "AF_INET6" もしくは nil が 指定できます。ただしIPv6が使えないようにコンパイルされている場合は "AF_INET6" は無効な指定となります。アドレスファミリーに nil を指定することは Socket::AF_UNSPEC を指定すること と等価です。

サービス、ホストの指定に関しては [[m:socket#サービス指定形式]]、 [[m:socket#ホスト指定形式]]を参照してください。

要素が3つの場合でも、ホストにはアドレスを指定できますが、要素が4つ の場合には、最後の要素を名前解決しないことが保証されます。 2002-01-01

省略可能な第2引数 flags には getnameinfo(3) の第7番目の引数に指定する flags に相当する Fixnum を与えます。

引数flagsを構成するための定数として Socket::NI_MAXHOST、 Socket::NI_MAXSERV、 Socket::NI_NOFQDN、 Socket::NI_NUMERICHOST、 Socket::NI_NAMEREQD、 Socket::NI_NUMERICSERV、 Socket::NI_DGRAM が用意されている場合があります。

これらの定数の意味については getnameinfo(3)を参照 して下さい。

例:

Socket.getnameinfo(Socket.sockaddr_in('21','127.0.0.1'))
#=> ["localhost", "ftp"]

Socket.getnameinfo([nil, 21,'127.0.0.1'])
#=> ["localhost", "ftp"]

getservbyname(service[, proto])

service, protoに対応するポート番号を返 します。protoの省略値は"tcp"です。

open(domain, type, protocol)

new(domain, type, protocol)

新しいソケットを生成します。domain、type、 protocol はインクルードファイルにある定数で指定しま す。ほとんどの定数は Socket::AF_INET のように Socket クラスの定数として定義されています。domain とtype に関しては、"AF_INET", "SOCK_STREAM" のように文字列でも指定できますが、文 字列ですべての機能を指定できる保証はありません。

例えば、IPv4 の TCP ソケットは以下のように生成されます。

s = Socket.new(Socket::AF_INET, Socket::SOCK_STREAM, 0)

なお、socket(2) の domain 引数において AF_ と PF_ のどちらの定数を使用するかについては混乱がありますが、 Stevens の「UNIX ネットワークプログラミング第2版 Vol.1」4.2節に述べられているように、 現実的にはどちらでも問題なく、また、既存のコーディング習慣として AF_ が用いられることが多いため、 ここでは AF_ を使用しています。

sockaddr_in(port, host)

pack_sockaddr_in(port, host)

指定したアドレスを[[m:socket#ソケットアドレス構造体を pack した文字列]] で返します。port は、ポート番号を表す Fixnum あるいは、ポート 番号、サービス名を表す文字列です。

例:

require 'socket'
p Socket.sockaddr_in("echo", "localhost")
=> "\002\000\000\a\177\000\000\001\000\000\000\000\000\000\000\000"
p Socket.sockaddr_in("echo", "::1")
=> "\n\000\000\a\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\001\000\000\000\000"

sockaddr_un(path)

pack_sockaddr_un(path)

指定したアドレスを[[m:socket#ソケットアドレス構造体を pack した文字列]] で返します。

例:

require 'socket'
p Socket.sockaddr_un("/tmp/.X11-unix/X0")
=> "\001\000/tmp/.X11-unix/X0\000...."

pair(domain, type, protocol)

socketpair(domain, type, protocol)

相互に結合されたソケットのペアを含む2要素の配列を返します。 引数の指定は Socket.open と同じです。

unpack_sockaddr_in(sockaddr)

[[m:socket#ソケットアドレス構造体を pack した文字列]]を unpack したアドレスを返します。返される値は [port, ipaddr] の配列です。

例:

require 'socket'
p Socket.unpack_sockaddr_in(Socket.sockaddr_in("echo", "localhost"))
=> [7, "127.0.0.1"]
p Socket.unpack_sockaddr_in(Socket.sockaddr_in("echo", "::1"))
=> [7, "::1"]

unpack_sockaddr_un(sockaddr)

[[m:socket#ソケットアドレス構造体を pack した文字列]]を unpack したソケットパス名を返します。

例:

require 'socket'
p Socket.unpack_sockaddr_un(Socket.sockaddr_un("/tmp/.X11-unix/X0"))
=> "/tmp/.X11-unix/X0"

インスタンスメソッド

accept

新しい接続を受け付けて、新しい接続に対するソケットとアドレスの ペアを返します。accept(2) を参照。

たとえば IPv4 の TCP サーバソケットを生成し、accept でクライアントからの接続を受け付けるには以下のようにします。

例:

serv = Socket.new(Socket::AF_INET, Socket::SOCK_STREAM, 0)
sockaddr = Socket.sockaddr_in(8080, "0.0.0.0")
serv.bind(sockaddr)
serv.listen(5)
sock = serv.accept

accept_nonblock

ソケットをノンブロッキングモードに設定した後、 accept(2) を呼び出します。

引数、返り値は Socket#accept と同じです。

accept(2) がエラーになった場合、 EAGAIN, EINTR を含め例外 Errno::EXXX が発生します。

bind(my_sockaddr)

ソケットを my_sockaddr に結合します。bind(2) と同じ働きをします。my_sockaddr は [[m:socket#ソケットアドレス構造体を pack した文字列]] です。

0 を返します。

connect(server_sockaddr)

connect(2) と同じ働きをします。server_sockaddr は、 [[m:socket#ソケットアドレス構造体を pack した文字列]] です。

0 を返します。

たとえば IPv4 の TCP ソケットを生成し、connect で www.ruby-lang.org:80 に接続するには以下のようにします。

例:

s = Socket.new(Socket::AF_INET, Socket::SOCK_STREAM, 0)
sockaddr = Socket.sockaddr_in(80, "www.ruby-lang.org")
s.connect(sockaddr)
s.write "GET / HTTP/1.0\r\n\r\n"
print s.read

connect_nonblock(server_sockaddr)

ソケットをノンブロッキングモードに設定した後、 connect(2) を呼び出します。

引数、返り値は Socket#connect と同じです。

connect(2)がエラーになった場合、 EINPROGRESS を含め例外 Errno::EXXX が発生します。

listen(backlog)

listen(2) と同じ働きをします。

0 を返します。

recvfrom(maxlen[, flags])

recv と同様にソケットからデータを受け取りますが、 戻り値は文字列と相手ソケットのアドレスのペアです。引数につい ては recv と同様です。

例:

s1 = Socket.new(Socket::AF_INET, Socket::SOCK_DGRAM, 0)
s2 = Socket.new(Socket::AF_INET, Socket::SOCK_DGRAM, 0)
s1.bind(Socket.sockaddr_in(0, "0.0.0.0"))
s2.send("foo", 0, s1.getsockname)
mesg, sockaddr = s1.recvfrom(10)
p mesg                                    #=> "foo"
p sockaddr                                #=> "\002\000\200r\177\000\000\001\000\000\000\000\000\000\000\000"
p Socket.unpack_sockaddr_in(sockaddr)     #=> [32882, "127.0.0.1"]

recvfrom_nonblock(maxlen[, flags])

ソケットをノンブロッキングモードに設定した後、 recvfrom(2) を呼び出します。

引数、返り値は Socket#recvfrom と同じです。

recvfrom(2) がエラーになった場合、 EAGAIN, EINTR を含め例外 Errno::EXXX が発生します。

sysaccept

接続したクライアントのファイル記述子とアドレスのペアを返すことを除 けば Socket#accept と同じです。

定数

AF_APPLETALK

AF_ATM

AF_AX25

AF_CCITT

AF_CHAOS

AF_CNT

AF_COIP

AF_DATAKIT

AF_DEC

AF_DLI

AF_E164

AF_ECMA

AF_HYLINK

AF_IMPLINK

AF_INET

AF_INET6

AF_IPX

AF_ISDN

AF_ISO

AF_LAT

AF_LINK

AF_LOCAL

AF_MAX

AF_NATM

AF_NDRV

AF_NETBIOS

AF_NETGRAPH

AF_NS

AF_OSI

AF_PPP

AF_PUP

AF_ROUTE

AF_SIP

AF_SNA

AF_SYSTEM

AF_UNIX

AF_UNSPEC

アドレスファミリー: Socket.open の第一引数 domain に使用します。

AI_ADDRCONFIG

AI_ALL

AI_CANONNAME

AI_DEFAULT

AI_MASK

AI_NUMERICHOST

AI_PASSIVE

AI_V4MAPPED

AI_V4MAPPED_CFG

フラグ: Socket.getaddrinfo の flags 引数に使用します。 getaddrinfo(3)も参照して下さい。

EAI_ADDRFAMILY

EAI_AGAIN

EAI_BADFLAGS

EAI_BADHINTS

EAI_FAIL

EAI_FAMILY

EAI_MAX

EAI_MEMORY

EAI_NODATA

EAI_NONAME

EAI_PROTOCOL

EAI_SERVICE

EAI_SOCKTYPE

EAI_SYSTEM

Socket.getaddrinfoが失敗したときに返すエラーコードです。 getaddrinfo(3)も参照して下さい。

INADDR_ALLHOSTS_GROUP

INADDR_ANY

INADDR_BROADCAST

INADDR_LOOPBACK

INADDR_MAX_LOCAL_GROUP

INADDR_NONE

INADDR_UNSPEC_GROUP

IPPORT_RESERVED

IPPORT_USERRESERVED

IPPROTO_BIP

IPPROTO_EGP

IPPROTO_EON

IPPROTO_GGP

IPPROTO_HELLO

IPPROTO_ICMP

IPPROTO_IDP

IPPROTO_IGMP

IPPROTO_IP

IPPROTO_MAX

IPPROTO_ND

IPPROTO_PUP

IPPROTO_RAW

IPPROTO_TCP

IPPROTO_TP

IPPROTO_UDP

IPPROTO_XTP

IPプロトコル: BasicSocket#getsockopt, BasicSocket#setsockopt の level 引数に 使用します。

また、Socket.open の 第一引数 domain に AF_INET もしくは AF_INET6, 第二引数 type に SOCK_RAW を指定した場合の、 第三引数 protocol にも使用します。

なお、AF_INET で SOCK_STREAM な場合には IPPROTO_TCP を使用できますが、 その場合は 0 を指定しても同じ結果を得られますので通常は使用されません。 AF_INET で SOCK_DGRAM の場合の IPPROTO_UDP も同様です。

IP_ADD_MEMBERSHIP

IP_DEFAULT_MULTICAST_LOOP

IP_DEFAULT_MULTICAST_TTL

IP_DROP_MEMBERSHIP

IP_HDRINCL

IP_MAX_MEMBERSHIPS

IP_MULTICAST_IF

IP_MULTICAST_LOOP

IP_MULTICAST_TTL

IP_OPTIONS

IP_RECVDSTADDR

IP_RECVOPTS

IP_RECVRETOPTS

IP_RETOPTS

IP_TOS

IP_TTL

MSG_COMPAT

MSG_CTRUNC

MSG_DONTROUTE

MSG_DONTWAIT

MSG_EOF

MSG_EOR

MSG_FLUSH

MSG_HAVEMORE

MSG_HOLD

MSG_OOB

MSG_PEEK

MSG_RCVMORE

MSG_SEND

MSG_TRUNC

MSG_WAITALL

NI_DGRAM

NI_MAXHOST

NI_MAXSERV

NI_NAMEREQD

NI_NOFQDN

NI_NUMERICHOST

NI_NUMERICSERV

Socket.getnameinfoの第2引数 flags に与える定数です。 getnameinfo(3)も参照して下さい。

PF_APPLETALK

PF_ATM

PF_AX25

PF_CCITT

PF_CHAOS

PF_CNT

PF_COIP

PF_DATAKIT

PF_DEC

PF_DLI

PF_ECMA

PF_HYLINK

PF_IMPLINK

PF_INET

PF_INET6

PF_IPX

PF_ISDN

PF_ISO

PF_KEY

PF_LAT

PF_LINK

PF_LOCAL

PF_MAX

PF_NATM

PF_NDRV

PF_NETBIOS

PF_NETGRAPH

PF_NS

PF_OSI

PF_PIP

PF_PPP

PF_PUP

PF_ROUTE

PF_RTIP

PF_SIP

PF_SNA

PF_SYSTEM

PF_UNIX

PF_UNSPEC

PF_XTP

プロトコルファミリー: Socket.open の第三引数 protocol に使用します。

SHUT_RD

SHUT_RDWR

SHUT_WR

shutdown の how: BasicSocket#shutdown の how 引数に使用します。

SOCK_DGRAM

SOCK_PACKET

SOCK_RAW

SOCK_RDM

SOCK_SEQPACKET

SOCK_STREAM

ソケットタイプ: Socket.open の第二引数 type に使用します。

SOL_ATALK

SOL_AX25

SOL_IP

SOL_IPX

SOL_SOCKET

SOL_TCP

SOL_UDP

SOPRI_BACKGROUND

SOPRI_INTERACTIVE

SOPRI_NORMAL

SO_ACCEPTCONN

SO_ACCEPTFILTER

SO_ATTACH_FILTER

SO_BINDTODEVICE

SO_BROADCAST

SO_DEBUG

SO_DETACH_FILTER

SO_DONTROUTE

SO_DONTTRUNC

SO_ERROR

SO_KEEPALIVE

SO_LINGER

SO_NKE

SO_NOSIGPIPE

SO_NO_CHECK

SO_NREAD

SO_OOBINLINE

SO_PASSCRED

SO_PEERCRED

SO_PEERNAME

SO_PRIORITY

SO_RCVBUF

SO_RCVLOWAT

SO_RCVTIMEO

SO_REUSEADDR

SO_REUSEPORT

SO_SECURITY_AUTHENTICATION

SO_SECURITY_ENCRYPTION_NETWORK

SO_SECURITY_ENCRYPTION_TRANSPORT

SO_SNDBUF

SO_SNDLOWAT

SO_SNDTIMEO

SO_TIMESTAMP

SO_TYPE

SO_USELOOPBACK

SO_WANTMORE

SO_WANTOOBFLAG

TCP_MAXSEG

TCP_NODELAY