|
Foundation 1.1.2 | |||||||||
前のクラス 次のクラス | フレームあり フレームなし | |||||||||
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド |
java.lang.Objectjava.net.Socket
public class Socket
このクラスは、クライアントソケット (単に「ソケット」とも呼ばれる) を実装します。ソケットとは、2 つのマシン間で通信を行う際の端点のことです。
ソケットの実際の処理は、SocketImpl
クラスのインスタンスによって実行されます。アプリケーションは、ソケット実装を作成するソケットファクトリを変更することで、ローカルファイアウォールに適したソケットを作成するように自身を構成することができます。
setSocketImplFactory(java.net.SocketImplFactory)
,
SocketImpl
コンストラクタの概要 | |
---|---|
|
Socket()
システムでデフォルトになっているタイプの SocketImpl を使用して、接続されていないソケットを作成します。 |
|
Socket(InetAddress address,
int port)
ストリームソケットを作成し、指定された IP アドレスの指定されたポート番号に接続します。 |
|
Socket(InetAddress address,
int port,
InetAddress localAddr,
int localPort)
ソケットを作成し、指定されたリモートポート上の指定されたリモートアドレスに接続します。 |
protected |
Socket(SocketImpl impl)
ユーザーが指定した SocketImpl を使用して、接続されていないソケットを作成します。 |
|
Socket(String host,
int port)
ストリームソケットを作成し、指定されたホスト上の指定されたポート番号に接続します。 |
|
Socket(String host,
int port,
InetAddress localAddr,
int localPort)
ソケットを作成し、指定されたリモートポート上の指定されたリモートホストに接続します。 |
メソッドの概要 | |
---|---|
void |
bind(SocketAddress bindpoint)
ソケットをローカルアドレスにバインドします。 |
void |
close()
このソケットを閉じます。 |
void |
connect(SocketAddress endpoint)
このソケットをサーバーに接続します。 |
void |
connect(SocketAddress endpoint,
int timeout)
指定されたタイムアウト値を使用してこのソケットをサーバーに接続します。 |
InetAddress |
getInetAddress()
ソケットの接続先のアドレスを返します。 |
InputStream |
getInputStream()
このソケットの入力ストリームを返します。 |
boolean |
getKeepAlive()
SO_KEEPALIVE が有効かどうかを調べます。 |
InetAddress |
getLocalAddress()
ソケットのバインド先のローカルアドレスを取得します。 |
int |
getLocalPort()
このソケットのバインド先のローカルポートを返します。 |
SocketAddress |
getLocalSocketAddress()
このソケットがバインドされている端点のアドレスを返します。 |
boolean |
getOOBInline()
OOBINLINE が有効かどうかを調べます。 |
OutputStream |
getOutputStream()
このソケットの出力ストリームを返します。 |
int |
getPort()
このソケットの接続先のリモートポートを返します。 |
int |
getReceiveBufferSize()
この Socket で使われる SO_RCVBUF オプションの値を取得します。 |
SocketAddress |
getRemoteSocketAddress()
このソケットが接続されている端点のアドレスを返します。 |
boolean |
getReuseAddress()
SO_REUSEADDR が有効かどうかを調べます。 |
int |
getSendBufferSize()
この Socket で使われる SO_SNDBUF オプションの値を取得します。 |
int |
getSoLinger()
SO_LINGER の設定を返します。 |
int |
getSoTimeout()
SO_TIMEOUT の設定を返します。 |
boolean |
getTcpNoDelay()
TCP_NODELAY が有効かどうかを調べます。 |
int |
getTrafficClass()
このソケットから送信されるパケットの IP ヘッダーのトラフィッククラスまたはサービスタイプを取得します。 |
boolean |
isBound()
ソケットのバインディング状態を返します。 |
boolean |
isClosed()
ソケットの閉じた状態を返します。 |
boolean |
isConnected()
ソケットの接続状態を返します。 |
boolean |
isInputShutdown()
ソケット接続の読み込み側の半分が閉じているかどうかを返します。 |
boolean |
isOutputShutdown()
ソケット接続の書き込み側の半分が閉じているかどうかを返します。 |
void |
sendUrgentData(int data)
このソケット上で 1 バイトの緊急データを送信します。 |
void |
setKeepAlive(boolean on)
SO_KEEPALIVE を有効または無効にします。 |
void |
setOOBInline(boolean on)
OOBINLINE (TCP 緊急データの受信) を有効または無効にします。 |
void |
setReceiveBufferSize(int size)
この Socket の SO_RCVBUF オプションを指定された値に設定します。 |
void |
setReuseAddress(boolean on)
SO_REUSEADDR ソケットオプションを有効または無効にします。 |
void |
setSendBufferSize(int size)
この Socket の SO_SNDBUF オプションを指定された値に設定します。 |
static void |
setSocketImplFactory(SocketImplFactory fac)
アプリケーションのクライアントソケット実装ファクトリを設定します。 |
void |
setSoLinger(boolean on,
int linger)
指定された遅延時間 (秒) を使って SO_LINGER を有効または無効にします。 |
void |
setSoTimeout(int timeout)
指定されたタイムアウト (ミリ秒) を使って SO_TIMEOUT を有効または無効にします。 |
void |
setTcpNoDelay(boolean on)
TCP_NODELAY を有効または無効にします (Nagle のアルゴリズムの有効、無効の切り替え)。 |
void |
setTrafficClass(int tc)
このソケットから送信されるパケットの IP ヘッダーのトラフィッククラスまたはサービスタイプのオクテットを設定します。 |
void |
shutdownInput()
このソケットの入力ストリームを「ストリームの終わり」に設定します。 |
void |
shutdownOutput()
このソケットの出力ストリームを無効にします。 |
String |
toString()
このソケットを String に変換します。 |
クラス java.lang.Object から継承されたメソッド |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
コンストラクタの詳細 |
---|
public Socket()
protected Socket(SocketImpl impl) throws SocketException
impl
- サブクラスが Socket 上で使用する SocketImpl のインスタンス
SocketException
- 使用しているプロトコルでエラー (TCP エラーなど) が発生した場合public Socket(String host, int port) throws UnknownHostException, IOException
指定されたホストが null の場合、それは、アドレスを InetAddress.getByName
(null) と指定するのと等価になります。つまり、それは、ループバックインタフェースのアドレスを指定するのと等価になります。
アプリケーションでサーバーソケットファクトリを指定している場合は、そのファクトリの createSocketImpl
メソッドが呼び出され、実際のソケットが作成されます。そうでない場合は「プレーンな」ソケットが作成されます。
セキュリティーマネージャーが存在する場合、セキュリティーマネージャーの checkConnect
が、引数としてホストアドレスと port
番号を指定して呼び出されます。この結果、SecurityException になることがあります。
host
- ホスト名。ループバックアドレスの場合は null
port
- ポート番号
UnknownHostException
- ホストの IP アドレスを決定できなかった場合
IOException
- ソケットの生成中に入出力エラーが発生した場合
SecurityException
- セキュリティーマネージャーが存在し、その checkConnect
メソッドがこの操作を許可しない場合setSocketImplFactory(java.net.SocketImplFactory)
,
SocketImpl
,
SocketImplFactory.createSocketImpl()
,
SecurityManager.checkConnect(java.lang.String, int)
public Socket(InetAddress address, int port) throws IOException
アプリケーションでソケットファクトリを指定している場合は、そのファクトリの createSocketImpl
メソッドが呼び出され、実際のソケットが作成されます。そうでない場合は「プレーンな」ソケットが作成されます。
セキュリティーマネージャーが存在する場合、セキュリティーマネージャーの checkConnect
が、引数としてホストアドレスと port
番号を指定して呼び出されます。この結果、SecurityException になることがあります。
address
- IP アドレスport
- ポート番号
IOException
- ソケットの生成中に入出力エラーが発生した場合
SecurityException
- セキュリティーマネージャーが存在し、その checkConnect
メソッドがこの操作を許可しない場合setSocketImplFactory(java.net.SocketImplFactory)
,
SocketImpl
,
SocketImplFactory.createSocketImpl()
,
SecurityManager.checkConnect(java.lang.String, int)
public Socket(String host, int port, InetAddress localAddr, int localPort) throws IOException
指定されたホストが null の場合、それは、アドレスを InetAddress.getByName
(null) と指定するのと等価になります。つまり、それは、ループバックインタフェースのアドレスを指定するのと等価になります。
セキュリティーマネージャーが存在する場合、セキュリティーマネージャーの checkConnect
が、引数としてホストアドレスと port
番号を指定して呼び出されます。この結果、SecurityException になることがあります。
host
- リモートホストの名前。ループバックアドレスの場合は null
port
- リモートポートlocalAddr
- ソケットのバインド先のローカルアドレスlocalPort
- ソケットのバインド先のローカルポート
IOException
- ソケットの生成中に入出力エラーが発生した場合
SecurityException
- セキュリティーマネージャーが存在し、その checkConnect
メソッドがこの操作を許可しない場合SecurityManager.checkConnect(java.lang.String, int)
public Socket(InetAddress address, int port, InetAddress localAddr, int localPort) throws IOException
セキュリティーマネージャーが存在する場合、セキュリティーマネージャーの checkConnect
が、引数としてホストアドレスと port
番号を指定して呼び出されます。この結果、SecurityException になることがあります。
address
- リモートアドレスport
- リモートポートlocalAddr
- ソケットのバインド先のローカルアドレスlocalPort
- ソケットのバインド先のローカルポート
IOException
- ソケットの生成中に入出力エラーが発生した場合
SecurityException
- セキュリティーマネージャーが存在し、その checkConnect
メソッドがこの操作を許可しない場合SecurityManager.checkConnect(java.lang.String, int)
メソッドの詳細 |
---|
public void connect(SocketAddress endpoint) throws IOException
endpoint
- SocketAddress
IOException
- 接続時にエラーが発生した場合
IllegalArgumentException
- 端点が null であるか、このソケットによってサポートされていない SocketAddress サブクラスである場合public void connect(SocketAddress endpoint, int timeout) throws IOException
endpoint
- SocketAddress
timeout
- 使用するタイムアウト値 (ミリ秒)
IOException
- 接続時にエラーが発生した場合
SocketTimeoutException
- 接続する前にタイムアウトが過ぎた場合
IllegalArgumentException
- 端点が null であるか、このソケットによってサポートされていない SocketAddress サブクラスである場合public void bind(SocketAddress bindpoint) throws IOException
アドレスが null
の場合は、システムにより一時的なポートと有効なローカルアドレスが選択されてソケットがバインドされます。
bindpoint
- バインド先の SocketAddress
IOException
- バインド操作に失敗した場合、あるいはソケットがすでにバインドされている場合
IllegalArgumentException
- bindpoint が、このソケットによってサポートされていない SocketAddress サブクラスである場合isBound()
public InetAddress getInetAddress()
null
public InetAddress getLocalAddress()
InetAddress.anyLocalAddress()
public int getPort()
public int getLocalPort()
public SocketAddress getRemoteSocketAddress()
null
を返します。
SocketAddress
。ソケットがまだ接続されていない場合は null
getInetAddress()
,
getPort()
,
connect(SocketAddress, int)
,
connect(SocketAddress)
public SocketAddress getLocalSocketAddress()
null
を返します。
SocketAddress
。ソケットがまだバインドされていない場合は null
getLocalAddress()
,
getLocalPort()
,
bind(SocketAddress)
public InputStream getInputStream() throws IOException
このソケットにチャネルが関連付けられている場合、結果として得られる入力ストリームは、その操作のすべてをチャネルに委譲します。
異常な状況下では、リモートホストやネットワークソフトウェアによって使用している接続が解除される可能性があります (TCP 接続の場合であれば接続がリセットされるなど)。接続の解除がネットワークソフトウェアによって検出された場合、返された入力ストリームに対して次のことが当てはまります。
ネットワークソフトウェアがソケットによってバッファリングされたバイトを破棄する可能性があります。ネットワークソフトウェアによって破棄されていないバイトは、read
を使って読み取ることができます。
ソケット上にバッファリングされたバイトが 1 つも存在しないか、バッファリングされたすべてのバイトが read
によって消費されてしまった場合、後続の read
呼び出しはすべて、IOException
をスローします。
ソケット上にバッファリングされたバイトが 1 つも存在せず、close
を使ってソケットがクローズされた場合、available
が 0
を返します。
IOException
- 入力ストリームの作成時に入出力エラーが発生した場合、ソケットがクローズされている場合、ソケットが接続されていない場合、または shutdownInput()
を使ってソケットの入力がシャットダウンされた場合public OutputStream getOutputStream() throws IOException
このソケットにチャネルが関連付けられている場合、結果として得られる出力ストリームは、その操作のすべてをチャネルに委譲します。
IOException
- 出力ストリームの作成中に入出力エラーが発生した場合、またはソケットが接続されていない場合public void setTcpNoDelay(boolean on) throws SocketException
on
- TCP_NODELAY を有効にする場合は true
、無効にする場合は false
SocketException
- 使用しているプロトコルでエラー (TCP エラーなど) が発生した場合getTcpNoDelay()
public boolean getTcpNoDelay() throws SocketException
boolean
値
SocketException
- 使用しているプロトコルでエラー (TCP エラーなど) が発生した場合setTcpNoDelay(boolean)
public void setSoLinger(boolean on, int linger) throws SocketException
on
- 遅延時間を有効にするかどうかを指定linger
- on が true の場合は、遅延時間
SocketException
- 使用しているプロトコルでエラー (TCP エラーなど) が発生した場合
IllegalArgumentException
- 遅延時間の値が負の数値である場合getSoLinger()
public int getSoLinger() throws SocketException
SocketException
- 使用しているプロトコルでエラー (TCP エラーなど) が発生した場合setSoLinger(boolean, int)
public void sendUrgentData(int data) throws IOException
data
- 送信するデータのバイト
IOException
- データ送信時にエラーが発生した場合public void setOOBInline(boolean on) throws SocketException
受信緊急データの処理に関しては、限られたサポートしか提供されていないことに注意してください。特に、高位レベルのプロトコルが提供されていない場合、受信する緊急データの通知は提供されず、通常データと緊急データを区別する機能はありません。
on
- OOBINLINE を有効にする場合は true
、無効にする場合は false
SocketException
- 使用しているプロトコルでエラー (TCP エラーなど) が発生した場合getOOBInline()
public boolean getOOBInline() throws SocketException
boolean
値
SocketException
- 使用しているプロトコルでエラー (TCP エラーなど) が発生した場合setOOBInline(boolean)
public void setSoTimeout(int timeout) throws SocketException
timeout
- ミリ秒で表される、指定されたタイムアウト
SocketException
- 使用しているプロトコルでエラー (TCP エラーなど) が発生した場合getSoTimeout()
public int getSoTimeout() throws SocketException
SocketException
- 使用しているプロトコルでエラー (TCP エラーなど) が発生した場合setSoTimeout(int)
public void setSendBufferSize(int size) throws SocketException
SO_SNDBUF はヒントなので、アプリケーションでバッファーのサイズ設定を調べる必要がある場合は、getSendBufferSize()
を呼び出してください。
size
- 送信バッファーサイズの設定サイズ。この値は 0 より大きくなければいけません。
SocketException
- 使用しているプロトコルでエラー (TCP エラーなど) が発生した場合
IllegalArgumentException
- 値が 0 または負の場合getSendBufferSize()
public int getSendBufferSize() throws SocketException
SocketException
- 使用しているプロトコルでエラー (TCP エラーなど) が発生した場合setSendBufferSize(int)
public void setReceiveBufferSize(int size) throws SocketException
受信バッファーのサイズを増やすと、大規模な接続でのネットワーク入出力のパフォーマンスを上げることができます。一方、サイズを減らすと、受信データのバックログを減らすことができます。
SO_RCVBUF はヒントなので、アプリケーションでバッファーのサイズ設定を調べる必要がある場合は、getReceiveBufferSize()
を呼び出してください。
SO_RCVBUF の値は、リモートピアに通知される TCP 受信ウィンドウの設定にも使用されます。一般に、ソケットが接続されているかぎり、このウィンドウサイズはいつでも変更できます。ただし、64K を超える受信ウィンドウを要求する場合は、ソケットをリモートピアに接続する前に変更を要求する必要があります。次の 2 つの場合に注意してください。
ServerSocket.setReceiveBufferSize(int)
を呼び出してこれを実行する必要があります。
size
- 受信バッファーサイズの設定サイズ。この値は 0 より大きくなければいけません。
IllegalArgumentException
- 値が 0 または負の場合
SocketException
- 使用しているプロトコルでエラー (TCP エラーなど) が発生した場合getReceiveBufferSize()
,
ServerSocket.setReceiveBufferSize(int)
public int getReceiveBufferSize() throws SocketException
SocketException
- 使用しているプロトコルでエラー (TCP エラーなど) が発生した場合setReceiveBufferSize(int)
public void setKeepAlive(boolean on) throws SocketException
on
- ソケットをオンのままにしておくかどうかを指定
SocketException
- 使用しているプロトコルでエラー (TCP エラーなど) が発生した場合getKeepAlive()
public boolean getKeepAlive() throws SocketException
boolean
値
SocketException
- 使用しているプロトコルでエラー (TCP エラーなど) が発生した場合setKeepAlive(boolean)
public void setTrafficClass(int tc) throws SocketException
tc の範囲は 0 <= tc <= 255
でなければいけません。そうでない場合は、IllegalArgumentException がスローされます。
注:
IP (Internet Protocol) Version 4 の場合、RFC 1349 で説明されているように、この値は優先度の高いオクテットと TOS フィールドで構成されます。TOS フィールドは、次のようにビット単位の論理和によって作成されるビットセットです。
IPTOS_LOWCOST (0x02)
IPTOS_RELIABILITY (0x04)
IPTOS_THROUGHPUT (0x08)
IPTOS_LOWDELAY (0x10)
優先フィールドにビットを設定すると、操作が許可されないことを示す SocketException になることがあります。
IP (Internet Protocol) Version 6 の場合、tc
は IP ヘッダーの sin6_flowinfo フィールドに格納される値です。
tc
- ビットセットの int
値
SocketException
- トラフィッククラスまたはサービスタイプの設定時にエラーが発生した場合getTrafficClass()
public int getTrafficClass() throws SocketException
使用するネットワーク実装が、#setTrafficClass()
を使用して設定されたトラフィッククラスまたはサービスタイプを無視することがあるので、この Socket で #setTrafficClass()
メソッドを使用して以前に設定された値とは異なる値がこのメソッドから返されることがあります。
SocketException
- トラフィッククラスまたはサービスタイプの値を取得する際にエラーが発生した場合setTrafficClass(int)
public void setReuseAddress(boolean on) throws SocketException
TCP 接続をクローズする場合、接続クローズ後の一定期間、その接続がタイムアウト状態 (通常、TIME_WAIT 状態または 2MSL 待機状態と呼ばれる) にとどまる可能性があります。周知のソケットアドレスまたはポートを使用するアプリケーションの場合、ソケットアドレスまたはポートに関連する接続がタイムアウト状態にあると、ソケットを必要な SocketAddress にバインドできないことがあります。
bind(SocketAddress)
を使用してソケットをバインドする前に SO_REUSEADDR を有効にすると、以前の接続がタイムアウト状態でもソケットをバインドすることができます。
Socket が作成されると、SO_REUSEADDR の初期設定は無効になります。
ソケットがバインドされた (isBound()
を参照) あとで SO_REUSEADDR を有効または無効にする場合の動作は定義されていません。
on
- ソケットオプションを有効にするか無効にするかを指定
SocketException
- SO_RESUEADDR ソケットオプションの有効化または無効化時にエラーが発生した場合、またはソケットがクローズされている場合getReuseAddress()
,
bind(SocketAddress)
,
isClosed()
,
isBound()
public boolean getReuseAddress() throws SocketException
boolean
値
SocketException
- 使用しているプロトコルでエラー (TCP エラーなど) が発生した場合setReuseAddress(boolean)
public void close() throws IOException
現在このソケットの入出力操作でブロックされているすべてのスレッドが SocketException
をスローします。
ソケットが閉じられると、その後のネットワークにそのソケットを使用することはできません (つまり、再接続または再バインドはできない)。新しいソケットを作成する必要があります。
このソケットに関連するチャネルが存在する場合は、そのチャネルも閉じられます。
IOException
- このソケットを閉じるときに入出力エラーが発生した場合isClosed()
public void shutdownInput() throws IOException
ソケットで shutdownInput() を呼び出したあとにソケットの入力ストリームから読み込むと、ストリームは EOF を返します。
IOException
- このソケットを停止するときに入出力エラーが発生した場合shutdownOutput()
,
close()
,
setSoLinger(boolean, int)
,
isInputShutdown()
public void shutdownOutput() throws IOException
IOException
- このソケットを停止するときに入出力エラーが発生した場合shutdownInput()
,
close()
,
setSoLinger(boolean, int)
,
isOutputShutdown()
public String toString()
String
に変換します。
Object
内の toString
public boolean isConnected()
public boolean isBound()
bind(java.net.SocketAddress)
public boolean isClosed()
close()
public boolean isInputShutdown()
shutdownInput()
public boolean isOutputShutdown()
shutdownOutput()
public static void setSocketImplFactory(SocketImplFactory fac) throws IOException
アプリケーションで新しいクライアントソケットを作成すると、ソケット実装ファクトリの createSocketImpl
メソッドが呼び出され、実際のソケットが作成されます。
セキュリティーマネージャーが存在する場合、このメソッドは最初にセキュリティーマネージャーの checkSetFactory
メソッドを呼び出すことにより、この操作が許可されていることを確認します。この結果、SecurityException がスローされることがあります。
fac
- 目的のファクトリ
IOException
- ソケットファクトリの設定中に入出力エラーが発生した場合
SocketException
- ファクトリがすでに定義されている場合
SecurityException
- セキュリティーマネージャーが存在し、その checkSetFactory
メソッドがこの操作を許可しない場合SocketImplFactory.createSocketImpl()
,
SecurityManager.checkSetFactory()
|
Foundation 1.1.2 | |||||||||
前のクラス 次のクラス | フレームあり フレームなし | |||||||||
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド |
Copyright 2006 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Documentation Redistribution Policy も参照してください。