jp.wda.gpss
インタフェース SocketProcessor

すべてのスーパーインタフェース:
AttributeContainer, InitParamContainer

public interface SocketProcessor
extends InitParamContainer, AttributeContainer

クライアントソケット処理インターフェース

導入されたバージョン:
1.00α 2003/04/29
バージョン:
1.00β007 2003/06/08
作成者:
amoi

メソッドの概要
 java.lang.String getClientID()
          このソケットを使用しているクライアントのクライアントIDを取得します。
 java.lang.String getEncoding()
          このソケットの使用するエンコーディング名を取得します。
 java.lang.String getIPAddress()
          このソケットを使用しているクライアントのIPアドレスを取得します。
 java.lang.String getPassword()
          setPassword(String s)メソッドで任意のパスワードに変更しない限り、 初期化パラメータで指定されたパスワードを取得します。
 java.lang.String getUserName()
          setUserName(String s)メソッドで任意のユーザ名に変更しない限り、 初期化パラメータで指定されたユーザー名を取得します。
 boolean isTerminated()
          このソケットを使用しているクライアントが既に終了しているかを確認します。
 boolean send(java.lang.String message)
          このソケットを使用しているクライアントにメッセージを送ります。
 void setPassword(java.lang.String s)
          パスワードを設定します。
 void setUserName(java.lang.String s)
          ユーザー名を設定します。
 void terminate()
          このソケットを使用しているクライアントを強制的に終了させます。
 void terminate(java.lang.String message)
          このソケットを使用しているクライアントに終了メッセージ送出後、ソケットを強制的に終了させます。
 
インタフェース jp.wda.gpss.system.InitParamContainer から継承したメソッド
getInitParam, getInitParamKeys, getInitParams, getInitParams, hasInitParam
 
インタフェース jp.wda.gpss.system.AttributeContainer から継承したメソッド
containsAttributeKey, getAttribute, getAttributeBoolean, getAttributeDouble, getAttributeInt, getAttributeKeys, getAttributeLong, getAttributes, removeAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute
 

メソッドの詳細

getClientID

public java.lang.String getClientID()
このソケットを使用しているクライアントのクライアントIDを取得します。
クライアントIDは、接続中の全クライアントに対し、一意な文字列となります。

戻り値:
クライアントID

getEncoding

public java.lang.String getEncoding()
このソケットの使用するエンコーディング名を取得します。
エンコーディング名は、初期設定ファイルで指定されます。

戻り値:
エンコーディング名

getUserName

public java.lang.String getUserName()
setUserName(String s)メソッドで任意のユーザ名に変更しない限り、 初期化パラメータで指定されたユーザー名を取得します。

戻り値:
ユーザー名

setUserName

public void setUserName(java.lang.String s)
ユーザー名を設定します。

パラメータ:
s - 設定値

getPassword

public java.lang.String getPassword()
setPassword(String s)メソッドで任意のパスワードに変更しない限り、 初期化パラメータで指定されたパスワードを取得します。

戻り値:
パスワード

setPassword

public void setPassword(java.lang.String s)
パスワードを設定します。

パラメータ:
s - 設定値

getIPAddress

public java.lang.String getIPAddress()
このソケットを使用しているクライアントのIPアドレスを取得します。

戻り値:
IPアドレス

send

public boolean send(java.lang.String message)
このソケットを使用しているクライアントにメッセージを送ります。
メッセージはnull文字"\0"を終端とします。

戻り値:
送信に成功した場合は真、失敗した場合は偽

terminate

public void terminate()
このソケットを使用しているクライアントを強制的に終了させます。


terminate

public void terminate(java.lang.String message)
このソケットを使用しているクライアントに終了メッセージ送出後、ソケットを強制的に終了させます。

パラメータ:
message - 終了メッセージ

isTerminated

public boolean isTerminated()
このソケットを使用しているクライアントが既に終了しているかを確認します。