JavaTM 2 Platform
Standard Ed. 5.0

java.net
クラス Socket

java.lang.Object
  上位を拡張 java.net.Socket
直系の既知のサブクラス:
SSLSocket

public class Socket
extends Object

このクラスは、クライアントソケット (単に「ソケット」とも呼ぶ) を実装します。ソケットとは 2 つのマシン間の通信の両端に位置するものです。

ソケットの実際の処理は SocketImpl クラスのインスタンスが行います。アプリケーションは、ソケットを作成するソケットファクトリを変更することによって、ローカルのファイアウォールに適したソケットを作成するように、アプリケーション自身を構成できます。

導入されたバージョン:
JDK1.0
関連項目:
setSocketImplFactory(java.net.SocketImplFactory), SocketImpl, SocketChannel

コンストラクタの概要
  Socket()
          システムでデフォルトになっているタイプの SocketImpl を使用して、接続されていないソケットを作成します。
  Socket(InetAddress address, int port)
          ストリームソケットを作成し、指定された IP アドレスの指定されたポート番号に接続します。
  Socket(InetAddress host, int port, boolean stream)
          推奨されていません。 UDP 転送ではなく DatagramSocket を使ってください。
  Socket(InetAddress address, int port, InetAddress localAddr, int localPort)
          ソケットを作成し、指定されたリモートポート上の指定されたリモートアドレスに接続します。
  Socket(Proxy proxy)
          (存在する場合は) ほかの設定にかかわらず使用するプロキシのタイプを指定し、接続されていないソケットを作成します。
protected Socket(SocketImpl impl)
          ユーザが指定した SocketImpl を使用して、接続されていないソケットを作成します。
  Socket(String host, int port)
          ストリームソケットを作成し、指定されたホスト上の指定されたポート番号に接続します。
  Socket(String host, int port, boolean stream)
          推奨されていません。 UDP 転送ではなく DatagramSocket を使ってください。
  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)
          指定されたタイムアウト値を使用してこのソケットをサーバに接続します。
 SocketChannel getChannel()
          このソケットに関連する固有の SocketChannel オブジェクトを返します (存在する場合)。
 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 setPerformancePreferences(int connectionTime, int latency, int bandwidth)
          このソケットのパフォーマンス設定を行います。
 void setReceiveBufferSize(int size)
          SO_RCVBUF オプションを、この Socket に指定された値に設定します。
 void setReuseAddress(boolean on)
          SO_REUSEADDR ソケットオプションを有効または無効にします。
 void setSendBufferSize(int size)
          SO_SNDBUF オプションを、この Socket に指定された値に設定します。
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)
          この Socket から送信されるパケットの IP ヘッダのトラフィッククラスまたはサービス型オクテットを設定します。
 void shutdownInput()
          このソケットの入力ストリームを「ストリームの最後」に配置します。
 void shutdownOutput()
          このソケットの出力ストリームを無効にします。
 String toString()
          このソケットを String に変換します。
 
クラス java.lang.Object から継承されたメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

コンストラクタの詳細

Socket

public Socket()
システムでデフォルトになっているタイプの SocketImpl を使用して、接続されていないソケットを作成します。

導入されたバージョン:
JDK1.1

Socket

public Socket(Proxy proxy)
(存在する場合は) ほかの設定にかかわらず使用するプロキシのタイプを指定し、接続されていないソケットを作成します。

セキュリティマネージャが存在する場合、セキュリティマネージャの checkConnect が、引数としてプロキシホストアドレスとポート番号を指定して呼び出されます。この結果、SecurityException になることがあります。

例:

パラメータ:
proxy - 使用するプロキシの種類を指定する Proxy オブジェクト
例外:
IllegalArgumentException - プロキシの型が無効または null である場合
SecurityException - セキュリティマネージャが存在し、プロキシへの接続のアクセス権が拒否された場合
導入されたバージョン:
1.5
関連項目:
ProxySelector, Proxy

Socket

protected Socket(SocketImpl impl)
          throws SocketException
ユーザが指定した SocketImpl を使用して、接続されていないソケットを作成します。

パラメータ:
impl - サブクラスが Socket 上で使用する SocketImpl のインスタンス
例外:
SocketException - 基本となるプロトコルで TCP エラーなどのエラーが発生した場合
導入されたバージョン:
JDK1.1

Socket

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)

Socket

public Socket(InetAddress address,
              int port)
       throws IOException
ストリームソケットを作成し、指定された IP アドレスの指定されたポート番号に接続します。

アプリケーションでサーバソケットファクトリを指定している場合は、そのファクトリの createSocketImpl メソッドが呼び出され、実際のソケットが作成されます。そうでない場合は「プレーンな」ソケットが作成されます。

セキュリティマネージャが存在する場合、セキュリティマネージャの checkConnect が、引数としてホストアドレスと port 番号を指定して呼び出されます。この結果、SecurityException になることがあります。

パラメータ:
address - IP アドレス
port - ポート番号
例外:
IOException - ソケットの作成中に入出力エラーが発生した場合
SecurityException - セキュリティマネージャが存在し、セキュリティマネージャの checkConnect メソッドがこの操作を許可しない場合
関連項目:
setSocketImplFactory(java.net.SocketImplFactory), SocketImpl, SocketImplFactory.createSocketImpl(), SecurityManager.checkConnect(java.lang.String, int)

Socket

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 メソッドがこの操作を許可しない場合
導入されたバージョン:
JDK1.1
関連項目:
SecurityManager.checkConnect(java.lang.String, int)

Socket

public Socket(InetAddress address,
              int port,
              InetAddress localAddr,
              int localPort)
       throws IOException
ソケットを作成し、指定されたリモートポート上の指定されたリモートアドレスに接続します。ソケットは、指定されたローカルアドレスとポートにバインドされます。

セキュリティマネージャが存在する場合、セキュリティマネージャの checkConnect が、引数としてホストアドレスと port 番号を指定して呼び出されます。この結果、SecurityException になることがあります。

パラメータ:
address - リモートアドレス
port - リモートポート
localAddr - ソケットのバインド先のローカルアドレス
localPort - ソケットのバインド先のローカルポート
例外:
IOException - ソケットの作成中に入出力エラーが発生した場合
SecurityException - セキュリティマネージャが存在し、セキュリティマネージャの checkConnect メソッドがこの操作を許可しない場合
導入されたバージョン:
JDK1.1
関連項目:
SecurityManager.checkConnect(java.lang.String, int)

Socket

@Deprecated
public Socket(String host,
                         int port,
                         boolean stream)
       throws IOException
推奨されていません。 UDP 転送ではなく DatagramSocket を使ってください。

ストリームソケットを作成し、指定されたホスト上の指定されたポート番号に接続します。

指定されたホストが null である場合、これは InetAddress.getByName(null) としてアドレスを指定するのと等価です。つまり、ループバックインタフェースのアドレスを指定することと等価です。

stream 引数に true を指定すると、ストリームソケットが作成されます。stream 引数に false を指定すると、データグラムソケットが作成されます。

アプリケーションでサーバソケットファクトリを指定している場合は、そのファクトリの createSocketImpl メソッドが呼び出され、実際のソケットが作成されます。そうでない場合は「プレーンな」ソケットが作成されます。

セキュリティマネージャが存在する場合、セキュリティマネージャの checkConnect が、引数としてホストアドレスと port 番号を指定して呼び出されます。この結果、SecurityException になることがあります。

UDP ソケットを使用する場合、TCP/IP に関連するソケットオプションは適用されません。

パラメータ:
host - ホスト名。ループバックアドレスの場合は null
port - ポート番号
stream - ストリームソケットかデータグラムソケットかを表わす boolean
例外:
IOException - ソケットの作成中に入出力エラーが発生した場合
SecurityException - セキュリティマネージャが存在し、セキュリティマネージャの checkConnect メソッドがこの操作を許可しない場合
関連項目:
setSocketImplFactory(java.net.SocketImplFactory), SocketImpl, SocketImplFactory.createSocketImpl(), SecurityManager.checkConnect(java.lang.String, int)

Socket

@Deprecated
public Socket(InetAddress host,
                         int port,
                         boolean stream)
       throws IOException
推奨されていません。 UDP 転送ではなく DatagramSocket を使ってください。

ソケットを作成し、指定された IP アドレスにある指定されたポート番号に接続します。

stream 引数に true を指定すると、ストリームソケットが作成されます。stream 引数に false を指定すると、データグラムソケットが作成されます。

アプリケーションでサーバソケットファクトリを指定している場合は、そのファクトリの createSocketImpl メソッドが呼び出され、実際のソケットが作成されます。そうでない場合は「プレーンな」ソケットが作成されます。

セキュリティマネージャが存在する場合、セキュリティマネージャの checkConnect メソッドが、引数として host.getHostAddress()port 番号を指定して呼び出されます。この結果、SecurityException になることがあります。

UDP ソケットを使用する場合、TCP/IP に関連するソケットオプションは適用されません。

パラメータ:
host - IP アドレス
port - ポート番号
stream - true を指定した場合はストリームソケットが作成され、そうでない場合はデータグラムソケットが作成される
例外:
IOException - ソケットの作成中に入出力エラーが発生した場合
SecurityException - セキュリティマネージャが存在し、セキュリティマネージャの checkConnect メソッドがこの操作を許可しない場合
関連項目:
setSocketImplFactory(java.net.SocketImplFactory), SocketImpl, SocketImplFactory.createSocketImpl(), SecurityManager.checkConnect(java.lang.String, int)
メソッドの詳細

connect

public void connect(SocketAddress endpoint)
             throws IOException
このソケットをサーバに接続します。

パラメータ:
endpoint - SocketAddress
例外:
IOException - 接続時にエラーが発生した場合
IllegalBlockingModeException - このソケットに関連するチャネルが存在し、そのチャネルが非ブロッキングモードの場合
IllegalArgumentException - 端点が null である場合、または端点がこのソケットでサポートされていない SocketAddress サブクラスである場合
導入されたバージョン:
1.4

connect

public void connect(SocketAddress endpoint,
                    int timeout)
             throws IOException
指定されたタイムアウト値を使用してこのソケットをサーバに接続します。タイムアウトに 0 を指定すると、タイムアウトは無限と解釈されます。その場合、接続が確立されるかエラーが発生するまで、接続はブロックされます。

パラメータ:
endpoint - SocketAddress
timeout - 使用するタイムアウト値 (ミリ秒)
例外:
IOException - 接続時にエラーが発生した場合
SocketTimeoutException - 接続する前にタイムアウトが過ぎた場合
IllegalBlockingModeException - このソケットに関連するチャネルが存在し、そのチャネルが非ブロッキングモードの場合
IllegalArgumentException - 端点が null である場合、または端点がこのソケットでサポートされていない SocketAddress サブクラスである場合
導入されたバージョン:
1.4

bind

public void bind(SocketAddress bindpoint)
          throws IOException
ソケットをローカルアドレスにバインドします。

アドレスが null の場合は、システムにより一時的なポートと有効なローカルアドレスが選択されてソケットがバインドされます。

パラメータ:
bindpoint - バインド先の SocketAddress
例外:
IOException - バインド操作に失敗した場合、あるいはソケットがすでにバインドされている場合
IllegalArgumentException - bindpoint がこのソケットでサポートされていない SocketAddress サブクラスである場合
導入されたバージョン:
1.4
関連項目:
isBound()

getInetAddress

public InetAddress getInetAddress()
ソケットの接続先のアドレスを返します。

戻り値:
このソケットの接続先のリモート IP アドレス。ソケットが接続されていない場合は null

getLocalAddress

public InetAddress getLocalAddress()
ソケットのバインド先のローカルアドレスを取得します。

戻り値:
ソケットのバインド先のローカルアドレス。ソケットがまだバインドされていない場合は InetAddress.anyLocalAddress()
導入されたバージョン:
JDK1.1

getPort

public int getPort()
このソケットの接続先のリモートポートを返します。

戻り値:
このソケットの接続先のリモートポート番号。ソケットがまだ接続されていない場合は 0

getLocalPort

public int getLocalPort()
このソケットのバインド先のローカルポートを返します。

戻り値:
このソケットのバインド先のローカルポート番号。ソケットがまだバインドされていない場合は -1

getRemoteSocketAddress

public SocketAddress getRemoteSocketAddress()
このソケットが接続されている端点のアドレスを返します。ソケットが接続されていない場合は null を返します。

戻り値:
このソケットのリモート端点を表す SocketAddress。ソケットがまだ接続されていない場合は null
導入されたバージョン:
1.4
関連項目:
getInetAddress(), getPort(), connect(SocketAddress, int), connect(SocketAddress)

getLocalSocketAddress

public SocketAddress getLocalSocketAddress()
このソケットがバインドされている端点のアドレスを返します。ソケットがバインドされていない場合は null を返します。

戻り値:
このソケットのローカル端点を表す SocketAddress。ソケットがまだバインドされていない場合は null
導入されたバージョン:
1.4
関連項目:
getLocalAddress(), getLocalPort(), bind(SocketAddress)

getChannel

public SocketChannel getChannel()
このソケットに関連する固有の SocketChannel オブジェクトを返します (存在する場合)。

チャネル自体が SocketChannel.open メソッドまたは ServerSocketChannel.accept メソッドを使用して作成された場合にだけ、ソケットにチャネルが存在します。

戻り値:
このソケットに関連するソケットチャネル。このソケットがチャネル用に作成されなかった場合は null
導入されたバージョン:
1.4

getInputStream

public InputStream getInputStream()
                           throws IOException
このソケットの入力ストリームを返します。

このソケットに関連するチャネルが存在する場合は、結果の入力ストリームはその操作をすべてチャネルに委譲します。そのチャネルが非ブロックモードの場合、入力ストリームの read 操作で IllegalBlockingModeException がスローされます。

異常な状況では、基本となる接続がリモートホストまたはネットワークソフトウェアによって切断されることがあります (例: TCP 接続の場合、接続のリセット)。ネットワークソフトウェアにより切断された接続が検出された場合、返される入力ストリームに以下が適用されます。

戻り値:
このソケットからバイトを読み取るための入力ストリーム
例外:
IOException - 入力ストリームの作成時に入出力エラーが発生した場合、ソケットが閉じられている場合、ソケットが接続されていない場合、またはソケット入力が shutdownInput() を使用して停止された場合

getOutputStream

public OutputStream getOutputStream()
                             throws IOException
このソケットの出力ストリームを返します。

このソケットに関連するチャネルが存在する場合は、結果の出力ストリームはその操作をすべてチャネルに委譲します。チャネルが非ブロックモードの場合、出力ストリームの write 操作で IllegalBlockingModeException がスローされます。

戻り値:
このソケットにバイトを書き込むための出力ストリーム
例外:
IOException - 出力ストリームの作成中に入出力エラーが発生した場合、あるいはソケットが接続されない場合

setTcpNoDelay

public void setTcpNoDelay(boolean on)
                   throws SocketException
TCP_NODELAY を有効または無効にします (Nagle のアルゴリズムの有効、無効の切り替え)。

パラメータ:
on - TCP_NODELAY を有効にする場合は true、無効にする場合は false
例外:
SocketException - 基本となるプロトコルで TCP エラーなどのエラーが発生した場合
導入されたバージョン:
JDK1.1
関連項目:
getTcpNoDelay()

getTcpNoDelay

public boolean getTcpNoDelay()
                      throws SocketException
TCP_NODELAY が有効かどうかを調べます。

戻り値:
TCP_NODELAY が有効かどうかを示す boolean
例外:
SocketException - 基本となるプロトコルで TCP エラーなどのエラーが発生した場合
導入されたバージョン:
JDK1.1
関連項目:
setTcpNoDelay(boolean)

setSoLinger

public void setSoLinger(boolean on,
                        int linger)
                 throws SocketException
指定された遅延時間 (秒単位) で、SO_LINGER を有効または無効にします。最大タイムアウトの値はプラットフォームに固有です。 設定はソケットを閉じる場合にだけ影響します。

パラメータ:
on - 遅延時間を有効にするかどうかを指定
linger - on が true の場合は、遅延時間
例外:
SocketException - 基本となるプロトコルで TCP エラーなどのエラーが発生した場合
IllegalArgumentException - 遅延時間の値が負の数値である場合
導入されたバージョン:
JDK1.1
関連項目:
getSoLinger()

getSoLinger

public int getSoLinger()
                throws SocketException
SO_LINGER の設定を返します。戻り値が -1 の場合は、このオプションが無効であることを示します。 設定はソケットを閉じる場合にだけ影響します。

戻り値:
SO_LINGER の設定
例外:
SocketException - 基本となるプロトコルで TCP エラーなどのエラーが発生した場合
導入されたバージョン:
JDK1.1
関連項目:
setSoLinger(boolean, int)

sendUrgentData

public void sendUrgentData(int data)
                    throws IOException
ソケット上の 1 バイトの緊急データを送信します。送信されるバイトはデータパラメータの最下位 8 ビットです。緊急データは、ソケットの OutputStream へのすべての先行する書き込みのあと、および OutputStream への今後の書き込みの前に送信されます。

パラメータ:
data - 送信するデータのバイト
例外:
IOException - データを送信するときにエラーが発生した場合
導入されたバージョン:
1.4

setOOBInline

public void setOOBInline(boolean on)
                  throws SocketException
OOBINLINE (TCP 緊急データの受信) を有効または無効にします。 デフォルトでは、このオプションは無効で、ソケットで受信した TCP 緊急データはそのまま破棄されます。緊急データを受信する場合は、このオプションを有効にする必要があります。有効にした場合、緊急データは通常データとともにインラインで受信されます。

受信する緊急データの処理には限定したサポートしか提供されないことに注意してください。特に、高位レベルのプロトコルが提供されていない場合、受信する緊急データの通知は提供されず、通常データと緊急データを区別する機能はありません。

パラメータ:
on - OOBINLINE を有効にする場合は true、無効にする場合は false
例外:
SocketException - 基本となるプロトコルで TCP エラーなどのエラーが発生した場合
導入されたバージョン:
1.4
関連項目:
getOOBInline()

getOOBInline

public boolean getOOBInline()
                     throws SocketException
OOBINLINE が有効かどうかを調べます。

戻り値:
OOBINLINE が有効かどうかを示す boolean
例外:
SocketException - 基本となるプロトコルで TCP エラーなどのエラーが発生した場合
導入されたバージョン:
1.4
関連項目:
setOOBInline(boolean)

setSoTimeout

public void setSoTimeout(int timeout)
                  throws SocketException
指定されたタイムアウト (ミリ秒単位) を使用して、SO_TIMEOUT を有効または無効にします。このオプションに 0 以外のタイムアウトを設定して、この Socket に関連した InputStream に対して read() を呼び出すと、設定した時間だけブロックされます。タイムアウトが過ぎると、Socket は有効なまま java.net.SocketTimeoutException が発生します。このオプションは、ブロック操作に入る前に有効にしておく必要があります。タイムアウトには 0 より大きい値を指定します。タイムアウトに 0 を指定すると、タイムアウトは無限と解釈されます。

パラメータ:
timeout - ミリ秒で表される、指定されたタイムアウト
例外:
SocketException - 基本となるプロトコルで TCP エラーなどのエラーが発生した場合
導入されたバージョン:
JDK 1.1
関連項目:
getSoTimeout()

getSoTimeout

public int getSoTimeout()
                 throws SocketException
SO_TIMEOUT の設定を返します。このオプションが無効 (タイムアウトが無限) の場合は 0 を返します。

戻り値:
SO_TIMEOUT の設定
例外:
SocketException - 基本となるプロトコルで TCP エラーなどのエラーが発生した場合
導入されたバージョン:
JDK1.1
関連項目:
setSoTimeout(int)

setSendBufferSize

public void setSendBufferSize(int size)
                       throws SocketException
SO_SNDBUF オプションを、この Socket に指定された値に設定します。SO_SNDBUF オプションは、使用するネットワーク入出力バッファに設定するサイズのヒントとして、プラットフォームのネットワークコードが使います。

SO_SNDBUF はヒントなので、アプリケーションでバッファのサイズ設定を調べる必要がある場合は、getSendBufferSize() を呼び出してください。

パラメータ:
size - 送信バッファ用として設定するサイズ。0 より大きい値を指定する必要がある
例外:
SocketException - 基本となるプロトコルで TCP エラーなどのエラーが発生した場合
IllegalArgumentException - 値が 0 または負の値である場合
導入されたバージョン:
1.2
関連項目:
getSendBufferSize()

getSendBufferSize

public int getSendBufferSize()
                      throws SocketException
この Socket で使われる SO_SNDBUF オプションの値を取得します。これは、この Socket で出力用としてプラットフォームが使うバッファのサイズです。

戻り値:
この Socket の SO_SNDBUF オプションの値
例外:
SocketException - 基本となるプロトコルで TCP エラーなどのエラーが発生した場合
導入されたバージョン:
1.2
関連項目:
setSendBufferSize(int)

setReceiveBufferSize

public void setReceiveBufferSize(int size)
                          throws SocketException
SO_RCVBUF オプションを、この Socket に指定された値に設定します。SO_RCVBUF オプションは、使用するネットワーク入出力バッファに設定するサイズのヒントとして、プラットフォームのネットワークコードが使います。

受信バッファのサイズを増やすと、大規模な接続でのネットワーク入出力のパフォーマンスを上げることができます。一方、サイズを減らすと、受信データのバックログを減らすことができます。

SO_RCVBUF はヒントなので、アプリケーションでバッファのサイズ設定を調べる必要がある場合は、getReceiveBufferSize() を呼び出してください。

SO_RCVBUF の値は、リモートピアに通知される TCP 受信ウィンドウの設定にも使用されます。一般に、ウィンドウサイズはソケットの接続時にいつでも変更できます。ただし、64K より大きい受信ウィンドウが必要な場合は、ソケットをリモートピアに接続するに変更を要求する必要があります。次の 2 つの点に留意してください。

  1. ServerSocket から受け入れたソケットの場合、ServerSocket をローカルアドレスにバインドする前に、ServerSocket.setReceiveBufferSize(int) を呼び出してこれを実行する必要がある

  2. クライアントソケットの場合、ソケットをそのリモートピアに接続する前に、setReceiveBufferSize() を呼び出す必要がある

パラメータ:
size - 受信バッファ用として設定するサイズ。0 より大きい値を指定する必要がある
例外:
IllegalArgumentException - 値が 0 または負の値である場合
SocketException - 基本となるプロトコルで TCP エラーなどのエラーが発生した場合
導入されたバージョン:
1.2
関連項目:
getReceiveBufferSize(), ServerSocket.setReceiveBufferSize(int)

getReceiveBufferSize

public int getReceiveBufferSize()
                         throws SocketException
この Socket で使われる SO_RCVBUF オプションの値を取得します。これは、この Socket で入力用としてプラットフォームが使うバッファのサイズです。

戻り値:
この Socket の SO_RCVBUF オプションの値
例外:
SocketException - 基本となるプロトコルで TCP エラーなどのエラーが発生した場合
導入されたバージョン:
1.2
関連項目:
setReceiveBufferSize(int)

setKeepAlive

public void setKeepAlive(boolean on)
                  throws SocketException
SO_KEEPALIVE を有効または無効にします。

パラメータ:
on - ソケットをオンのままにしておくかどうかを指定
例外:
SocketException - 基本となるプロトコルで TCP エラーなどのエラーが発生した場合
導入されたバージョン:
1.3
関連項目:
getKeepAlive()

getKeepAlive

public boolean getKeepAlive()
                     throws SocketException
SO_KEEPALIVE が有効かどうかを調べます。

戻り値:
SO_KEEPALIVE が有効かどうかを示す boolean
例外:
SocketException - 基本となるプロトコルで TCP エラーなどのエラーが発生した場合
導入されたバージョン:
1.3
関連項目:
setKeepAlive(boolean)

setTrafficClass

public void setTrafficClass(int tc)
                     throws SocketException
この Socket から送信されるパケットの IP ヘッダのトラフィッククラスまたはサービス型オクテットを設定します。使用するネットワーク実装がこの値を無視することがあるので、アプリケーションではこの値をヒントと考えてください。

tc の範囲は 0 <= tc <= 255なければなりません。そうでない場合は、IllegalArgumentException がスローされます。

注:

IP (Internet Protocol) バージョン 4 の場合、RFC 1349 で説明されているように、この値は優先順位の高いオクテットと TOS フィールドで構成されます。TOS フィールドは、次のようにビット単位の論理和によって作成されるビットセットです。

最下位ビットは、MBZ (0 でなければならない) ビットに対応するので、常に無視されます。

優先フィールドにビットを設定すると、操作が許可されないことを示す SocketException になることがあります。

IP (Internet Protocol) バージョン 6 の場合、tc は IP ヘッダの sin6_flowinfo フィールドに格納される値です。

パラメータ:
tc - ビットセットの int
例外:
SocketException - トラフィッククラスまたはサービス型を設定するときにエラーが発生した場合
導入されたバージョン:
1.4
関連項目:
getTrafficClass()

getTrafficClass

public int getTrafficClass()
                    throws SocketException
このソケットから送信されるパケットの IP ヘッダのトラフィッククラスまたはサービス型を取得します。

背後のネットワーク実装が、setTrafficClass(int) を使用して設定されたトラフィッククラスまたはサービス型を無視することがあるので、この Socket で setTrafficClass(int) メソッドを使用して以前に設定された値とは異なる値がこのメソッドから返されることがあります。

戻り値:
すでに設定されているトラフィッククラスまたはサービス型
例外:
SocketException - トラフィッククラスまたはサービス型の値を取得するときにエラーが発生した場合
導入されたバージョン:
1.4
関連項目:
setTrafficClass(int)

setReuseAddress

public void setReuseAddress(boolean on)
                     throws SocketException
SO_REUSEADDR ソケットオプションを有効または無効にします。

TCP 接続を閉じると、接続が閉じたあと、接続が一定の時間タイムアウト状態のままになることがあります (通常、TIME_WAIT 状態または 2MSL 待機状態と呼ばれる)。周知のソケットアドレスまたはポートを使用するアプリケーションの場合、ソケットアドレスまたはポートに関連する接続がタイムアウト状態にあると、ソケットを必要な SocketAddress にバインドできないことがあります。

bind(SocketAddress) を使用してソケットをバインドする前に SO_REUSEADDR を有効にすると、以前の接続がタイムアウト状態でもソケットをバインドすることができます。

Socket が作成されると、SO_REUSEADDR の初期設定は無効になります。

ソケットがバインドされた (isBound() を参照) あとで SO_REUSEADDR を有効または無効にする場合の動作は、定義されていません。

パラメータ:
on - ソケットオプションを有効にするか無効にするかを指定
例外:
SocketException - SO_RESUEADDR ソケットオプションを有効または無効にするときにエラーが発生する場合、あるいはソケットが閉じている場合
導入されたバージョン:
1.4
関連項目:
getReuseAddress(), bind(SocketAddress), isClosed(), isBound()

getReuseAddress

public boolean getReuseAddress()
                        throws SocketException
SO_REUSEADDR が有効かどうかを調べます。

戻り値:
SO_REUSEADDR が有効かどうかを示す boolean
例外:
SocketException - 基本となるプロトコルで TCP エラーなどのエラーが発生した場合
導入されたバージョン:
1.4
関連項目:
setReuseAddress(boolean)

close

public void close()
           throws IOException
このソケットを閉じます。

現在このソケットの入出力操作でブロックされているすべてのスレッドが SocketException をスローします。

ソケットが閉じられると、その後のネットワークにそのソケットを使用することはできません (つまり、再接続または再バインドはできない)。新しいソケットを作成する必要があります。

このソケットに関連するチャネルが存在する場合は、そのチャネルも閉じられます。

例外:
IOException - このソケットを閉じるときに入出力エラーが発生した場合
関連項目:
isClosed()

shutdownInput

public void shutdownInput()
                   throws IOException
このソケットの入力ストリームを「ストリームの最後」に配置します。ソケットの入力ストリーム側に送信されたデータは確認され、そのまま破棄されます。

ソケットで shutdownInput() を呼び出したあとにソケットの入力ストリームから読み取ると、ストリームは EOF を返します。

例外:
IOException - このソケットを停止するときに入出力エラーが発生した場合
導入されたバージョン:
1.3
関連項目:
shutdownOutput(), close(), setSoLinger(boolean, int), isInputShutdown()

shutdownOutput

public void shutdownOutput()
                    throws IOException
このソケットの出力ストリームを無効にします。TCP ソケットの場合、すでに書き込まれているデータが送信され、そのあとに TCP の通常の接続終了処理が続きます。 ソケットで shutdownOutput() を呼び出したあとにソケットの出力ストリームに書き込むと、ストリームは IOException をスローします。

例外:
IOException - このソケットを停止するときに入出力エラーが発生した場合
導入されたバージョン:
1.3
関連項目:
shutdownInput(), close(), setSoLinger(boolean, int), isOutputShutdown()

toString

public String toString()
このソケットを String に変換します。

オーバーライド:
クラス Object 内の toString
戻り値:
このソケットの文字列表現

isConnected

public boolean isConnected()
ソケットの接続状態を返します。

戻り値:
ソケットがサーバに正常に接続されている場合は true
導入されたバージョン:
1.4

isBound

public boolean isBound()
ソケットのバインディング状態を返します。

戻り値:
ソケットが正常にアドレスにバインドされている場合は true
導入されたバージョン:
1.4
関連項目:
bind(java.net.SocketAddress)

isClosed

public boolean isClosed()
ソケットの閉じた状態を返します。

戻り値:
ソケットが閉じた場合は true
導入されたバージョン:
1.4
関連項目:
close()

isInputShutdown

public boolean isInputShutdown()
ソケット接続の読み取り側の半分が閉じているかどうかを返します。

戻り値:
ソケットの入力が停止した場合は true
導入されたバージョン:
1.4
関連項目:
shutdownInput()

isOutputShutdown

public boolean isOutputShutdown()
ソケット接続の書き込み側の半分が閉じているかどうかを返します。

戻り値:
ソケットの出力が停止した場合は true
導入されたバージョン:
1.4
関連項目:
shutdownOutput()

setSocketImplFactory

public static void setSocketImplFactory(SocketImplFactory fac)
                                 throws IOException
アプリケーションのクライアントソケット実装ファクトリを設定します。ファクトリを設定できるのは 1 回だけです。

アプリケーションで新しいクライアントソケットを作成すると、ソケット実装ファクトリの createSocketImpl メソッドが呼び出され、実際のソケットが作成されます。

ファクトリがすでに設定されていないかぎり、メソッドに null を渡しても何も行われません。

セキュリティマネージャが存在する場合、このメソッドは最初にセキュリティマネージャの checkSetFactory メソッドを呼び出すことにより、この操作が許可されていることを確認します。この結果、SecurityException になることがあります。

パラメータ:
fac - 目的のファクトリ
例外:
IOException - ソケットファクトリの設定中に入出力エラーが発生した場合
SocketException - ファクトリがすでに定義されている場合
SecurityException - セキュリティマネージャが存在し、セキュリティマネージャの checkSetFactory メソッドがこの操作を許可しない場合
関連項目:
SocketImplFactory.createSocketImpl(), SecurityManager.checkSetFactory()

setPerformancePreferences

public void setPerformancePreferences(int connectionTime,
                                      int latency,
                                      int bandwidth)
このソケットのパフォーマンス設定を行います。

ソケットはデフォルトで TCP/IP プロトコルを使用します。実装によっては、TCP/IP とは異なるパフォーマンス特性を持つ代替プロトコルが提供されることもあります。アプリケーションは、このメソッドを使用することで、実装で利用可能なプロトコルの選択時に、これらのかね合いの取り方を示す独自の設定を表現できます。

パフォーマンス設定は、接続時間の短さ、応答時間の速さ、帯域幅の広さの相対的な重要度を示す 3 つの整数値によって記述されます。整数の絶対値に関係性はなく、プロトコルを選択するために値を単に比較します。値が大きければより強い設定を示します。負の値は、正の値よりも優先順位が低いことを表します。アプリケーションが応答時間の速さと帯域幅の広さよりも接続時間の短さを優先する場合、このメソッドを (1, 0, 0) という値で呼び出すことができます。アプリケーションが応答時間の速さよりも帯域幅の広さを、また接続時間の短さよりも応答時間の速さを優先する場合、このメソッドを (0, 1, 2) という値で呼び出すことができます。

このソケットが接続されたあとにこのメソッドを呼び出しても、何も行われません。

パラメータ:
connectionTime - 接続時間の短さの相対的な重要度を表す int
latency - 応答時間の速さの相対的な重要度を表す int
bandwidth - 帯域幅の広さの相対的な重要度を表す int
導入されたバージョン:
1.5

JavaTM 2 Platform
Standard Ed. 5.0

バグの報告と機能のリクエスト
さらに詳しい API リファレンスおよび開発者ドキュメントについては、Java 2 SDK SE 開発者用ドキュメントを参照してください。開発者向けの詳細な解説、概念の概要、用語の定義、バグの回避策、およびコード実例が含まれています。

Copyright 2004 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Documentation Redistribution Policy も参照してください。