|
|||||||||||
前のクラス 次のクラス | フレームあり フレームなし | ||||||||||
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド |
Sockletインターフェース
全てのSockletは、このインターフェースを実装する必要があります。
通常の場合は、jp.wda.gpss.GeneralSockletを継承する方が楽チンです。
メソッドの概要 | |
void |
addClient(SocketProcessor client)
指定したクライアントを、このSockletの接続中クライアント一覧に追加します。 |
void |
afterDeployedLinks(java.util.Map linkedSocklets)
このメソッドはinit(SockletDeployInfo info, List links, Progress progress)にて、 linksオブジェクトに設定された追加配備Sockletを配備し終えた後、サーバにより起動時に1回だけ呼ばれます。 |
boolean |
allowAccessFromOtherSocklet(Socklet from)
他のSockletからのアクセスを許可するかどうかを確認します。 |
boolean |
checkConnection(SocketProcessor client)
接続用初期コマンド受信後、クライアントの検査を行うためのメソッド。 |
int |
countClients()
現在接続中のクライアント数を数えます。 |
java.lang.String |
deployedBy()
このSockletを配備したSocklet名を取得します。 |
void |
deployedBy(ExecutableBase server,
java.lang.String name)
このSockletを配備したSocklet名を設定します。 |
void |
destroy()
Sockletがサービスを停止する際に、待受けメインサーバによって呼び出されます。 |
void |
disconnectAllClients(java.lang.String message)
このSockletに接続中の全クライアントを切断します。 |
boolean |
doCommand(SocketProcessor client,
java.lang.String command)
コマンドを処理するためのメソッド。 |
java.lang.String |
getName()
このSockletの配備名を取得します。 |
int |
getTimeout()
タイムアウト時間(ミリ秒単位)を取得します。 |
void |
init(SockletDeployInfo info,
java.util.List links,
Progress progress)
このSockletを初期化します。 |
void |
log(java.lang.Object message,
org.apache.log4j.Priority priority,
java.lang.Throwable throwable)
Socklet指定ログファイルか、それが登録されていない場合はシステムログファイルに、 指定された種類のログを出力します。 |
void |
preRemoveClient(SocketProcessor client)
クライアント削除前に呼び出されるメソッド。 |
void |
removeClient(SocketProcessor client)
指定したクライアントを、このSockletの接続中クライアント一覧から削除します。 |
void |
sendToAllClients(java.lang.String message)
このSockletに接続中の全てのクライアントに向けて、メッセージを送信します。 |
void |
sendToClients(java.lang.String message,
Finder finder)
このSockletに接続中のクライアントのうち、特定の条件を有するクライアントのみに向けて、メッセージを送信します。 |
void |
sendToClients(java.lang.String message,
java.lang.String condition)
このSockletに接続中のクライアントのうち、特定の条件を有するクライアントのみに向けて、メッセージを送信します。 |
void |
setTimeout(int timeout)
このSockletを配備したSocklet名を設定します。 |
メソッドの詳細 |
public boolean checkConnection(SocketProcessor client)
client
- 接続を試みているクライアント
SocketProcessor
public void preRemoveClient(SocketProcessor client)
client
- これから削除されるクライアントpublic boolean doCommand(SocketProcessor client, java.lang.String command)
client
- コマンドを送信してきたクライアントソケットcommand
- 受信したコマンド
public void init(SockletDeployInfo info, java.util.List links, Progress progress)
info
- Socklet配備情報links
- 自動的に追加配備したいSockletのSocklet配備情報オブジェクトを設定するためのListprogress
- ソケット処理状況進捗管理オブジェクト。public void afterDeployedLinks(java.util.Map linkedSocklets)
linkedSocklets
- 自動的に追加配備されたSockletのうち、このSockletからのアクセスを許可されたSocklet一覧を、Socklet配備名をキーとして保持するMapオブジェクトpublic void destroy()
public java.lang.String getName()
public int getTimeout()
public void setTimeout(int timeout)
public java.lang.String deployedBy()
public void deployedBy(ExecutableBase server, java.lang.String name)
public void addClient(SocketProcessor client)
client
- 追加するクライアントpublic void removeClient(SocketProcessor client)
client
- 削除するクライアントpublic int countClients()
public void disconnectAllClients(java.lang.String message)
message
- 閉鎖メッセージpublic void sendToAllClients(java.lang.String message)
message
- 送信するメッセージpublic void sendToClients(java.lang.String message, Finder finder)
message
- 送信するメッセージfinder
- 送信したいクライアント検索用オブジェクトSocketProcessorFinder.getFinder(String)
public void sendToClients(java.lang.String message, java.lang.String condition)
message
- 送信するメッセージcondition
- 送信したいクライアントの検索条件文SocketProcessorFinder.getFinder(String)
public boolean allowAccessFromOtherSocklet(Socklet from)
from
- アクセスを試みてきた、他のSocklet
public void log(java.lang.Object message, org.apache.log4j.Priority priority, java.lang.Throwable throwable)
message
- 出力するログメッセージpriority
- ログ情報種類throwable
- 発生したエラー
|
|||||||||||
前のクラス 次のクラス | フレームあり フレームなし | ||||||||||
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド |