SAMPClient

class astropy.samp.SAMPClient(hub, name=None, description=None, metadata=None, addr=None, port=0, callable=True)[ソース]

ベースクラス: object

ユーティリティクラスは、SAMPが呼び出し可能なクライアントアプリケーションとして機能するSAMP対応XML−RPCサーバを作成して管理するツールを提供する。

パラメータ
hub : SAMPHubProxySAMPHubProxy

1つの例です SAMPHubProxy SAMPハブとのメッセージ転送のために使用される。

name文字列、オプション

クライアント名(対応する) samp.name メタデータキーワード).

description文字列、オプション

クライアント記述(対応) samp.description.text メタデータキーワード).

metadataDICT、オプション

標準SAMPフォーマットのクライアントアプリケーションメタデータ。

addr文字列、オプション

アドレス(またはIP)をリッスンする。Internetにアクセスできない場合は，デフォルトで127.0.0.1とし，そうでなければデフォルトでマスタ名とする.

port形が整っていて、オプションです

XML-RPCサーバソケットポートをリッスンする.予約設定が0(デフォルト値)に設定されている場合、オペレーティングシステムは空きポートを選択します。

callableブル値、オプション

クライアントが呼び出しと通知を受信できるかどうか.もし設定が False したがって、クライアントは、通知および呼を送信することができるが、いかなる通知および呼を受信することもできない。

属性要約

is_registered \

クライアントが現在登録されているかどうか。

is_running \

クライアントが現在動作しているかどうか.

方法要約

bind_receive_call \(mtype，関数[, ...] )

特定のMType呼び出しを関数やクラスメソッドにバインドする.

bind_receive_message \(mtype，関数[, ...] )

特定のMTypeを呼び出しまたは通知のための関数またはクラスメソッドにバインドします。

bind_receive_notification \(mtype，関数[, ...] )

特定のMType通知を関数やクラスメソッドにバインドする.

bind_receive_response (メッセージ_タグ，関数)

特定のmsg−tag応答を関数またはクラス方法にバインドする。

declare_metadata \([metadata] )

サポートするクライアントアプリケーションメタデータを宣言する.

declare_subscriptions \([subscriptions] )

クライアントが購読したいMTypesを宣言し，MTypeバインディング方法を用いて暗黙的に定義する. bind_receive_notification() そして bind_receive_call() それがそうです。

get_private_key \()

登録時に得られた標準プロファイル通信のためのクライアント秘密鍵を返す. (samp.private-key ）。

get_public_id \()

登録時に取得したパブリッククライアントIDを返す (samp.self-id ）。

receive_call (秘密鍵_鍵，送信者_id，メッセージ_id，...)

標準的にクライアントを呼ぶことができる receive_call 方法です。

receive_notification \(プライベート_鍵，送信者_id，...)

標準的にクライアントを呼ぶことができる receive_notification 方法です。

receive_response \(プライベート_キー，応答者_id，...)

標準的にクライアントを呼ぶことができる receive_response 方法です。

register \()

クライアントをSAMPハブに登録する.

start \()

クライアントは単独のスレッド(非輻輳)で起動される.

stop \([timeout] )

クライアントを停止する.

unbind_receive_call \(mtype[, declare] )

呼び出し結束表から指定されたMTypeを削除し，クライアントの購読をキャンセルする(必要であれば).

unbind_receive_notification \(mtype[, declare] )

指定されたMTypeを通知結束テーブルから削除し、必要に応じてクライアントの加入をキャンセルします。

unbind_receive_response \(メッセージ_タグ)

指定されたメッセージタグは、応答結合テーブルから削除される。

unregister \()

SAMPハブからクライアントの登録をキャンセルします。

属性文書

is_registered

クライアントが現在登録されているかどうか。

is_running

クライアントが現在動作しているかどうか.

方法文書

bind_receive_call(mtype, function, declare=True, metadata=None)[ソース]

特定のMType呼び出しを関数やクラスメソッドにバインドする.

この関数のフォーマットは、以下のようにしなければならない。

def my_function_or_method(<self,> private_key, sender_id, msg_id,
                          mtype, params, extra)

どこだ？ private_key クライアントの秘密鍵です sender_id 送信者IDを通知することです msg_id ハブメッセージIDです mtype ニュースMTypeです params メッセージパラメータが設定されているかどうか(内容は "samp.params" )と extra 追加のメッセージマッピングエントリを含む辞書です。デフォルトでは，クライアントはMTypeの購読を自動的に宣言する.

パラメータ
mtype応力.応力

捕捉するmType.

function呼び戻すことができる

以下の場合に用いるアプリケーション関数 mtype 受け取りました。

declareブル値、オプション

クライアントがMTypeを購読していると自動的に宣言しなければならないかどうかを指定します(別途参照 declare_subscriptions() ）。

metadataDICT、オプション

購読しているMTypeに関連する宣言する他のメタデータを含む辞書(なお参照 declare_subscriptions() ）。

bind_receive_message(mtype, function, declare=True, metadata=None)[ソース]

特定のMTypeを呼び出しまたは通知のための関数またはクラスメソッドにバインドします。

この関数のフォーマットは、以下のようにしなければならない。

def my_function_or_method(<self,> private_key, sender_id, msg_id,
                          mtype, params, extra)

どこだ？ private_key クライアントの秘密鍵です sender_id 送信者IDを通知することです msg_id ハブメッセージID(呼び出しのみ，そうでなければ None )、 mtype ニュースMTypeです params メッセージパラメータが設定されているかどうか(内容は "samp.params" )と extra 追加のメッセージマッピングエントリを含む辞書です。デフォルトでは，クライアントはMTypeの購読を自動的に宣言する.

パラメータ
mtype応力.応力

捕捉するmType.

function呼び戻すことができる

以下の場合に用いるアプリケーション関数 mtype 受け取りました。

declareブル値、オプション

クライアントがMTypeを購読していると自動的に宣言しなければならないかどうかを指定します(別途参照 declare_subscriptions() ）。

metadataDICT、オプション

購読しているMTypeに関連する宣言する他のメタデータを含む辞書(なお参照 declare_subscriptions() ）。

bind_receive_notification(mtype, function, declare=True, metadata=None)[ソース]

特定のMType通知を関数やクラスメソッドにバインドする.

この関数のフォーマットは、以下のようにしなければならない。

def my_function_or_method(<self,> private_key, sender_id, mtype,
                          params, extra)

どこだ？ private_key クライアントの秘密鍵です sender_id 送信者IDを通知することです mtype ニュースMTypeです params 通知メッセージパラメータが設定されているかどうか(内容は "samp.params" )と extra 追加のメッセージマッピングエントリを含む辞書です。デフォルトでは，クライアントはMTypeの購読を自動的に宣言する.

パラメータ
mtype応力.応力

捕捉するmType.

function呼び戻すことができる

以下の場合に用いるアプリケーション関数 mtype 受け取りました。

declareブル値、オプション

クライアントがMTypeを購読していると自動的に宣言しなければならないかどうかを指定します(別途参照 declare_subscriptions() ）。

metadataDICT、オプション

購読しているMTypeに関連する宣言する他のメタデータを含む辞書(なお参照 declare_subscriptions() ）。

bind_receive_response(msg_tag, function)[ソース]

特定のmsg−tag応答を関数またはクラス方法にバインドする。

この関数のフォーマットは、以下のようにしなければならない。

def my_function_or_method(<self,> private_key, responder_id,
                          msg_tag, response)

どこだ？ private_key クライアントの秘密鍵です responder_id メッセージ応答者IDです msg_tag メッセージタグは呼び出し時に提供されるかどうか、および response 受け取った応答です。

パラメータ
msg_tag応力.応力

捕捉するメッセージタグ。

function呼び戻すことができる

以下の場合に用いるアプリケーション関数 msg_tag 受け取りました。

declare_metadata(metadata=None)[ソース]

サポートするクライアントアプリケーションメタデータを宣言する.

パラメータ
metadataDICT、オプション

SAMP定義文書に定義されているクライアントアプリケーションメタデータを含む辞書.省略されていれば，どのメタデータも宣言しない.

declare_subscriptions(subscriptions=None)[ソース]

クライアントが購読したいMTypesを宣言し，MTypeバインディング方法を用いて暗黙的に定義する. bind_receive_notification() そして bind_receive_call() それがそうです。

オプションの subscriptions 地図を追加して伝えることができます declare_subscriptions() 方法です。

パラメータ
subscriptionsDICT、オプション

購読するMTypeのリストを含む辞書のフォーマットと subscriptions 地図を渡します declare_subscriptions() 方法です。

get_private_key()[ソース]

登録時に得られた標準プロファイル通信のためのクライアント秘密鍵を返す. (samp.private-key ）。

返品
key応力.応力

クライアント秘密鍵。

get_public_id()[ソース]

登録時に取得したパブリッククライアントIDを返す (samp.self-id ）。

返品
id応力.応力

クライアント共通ID。

receive_call(private_key, sender_id, msg_id, message)[ソース]

標準的にクライアントを呼ぶことができる receive_call 方法です。

メソッドの場合は，このメソッドを自動的に処理する. bind_receive_call() 方法は，異なる操作をMTypeにバインドするために用いられる.カスタマイズされたクライアントが引継ぎを実現することができる場合 SAMPClient このような方法は書き換えられるべきである.

注釈

上書きされた場合，この方法はつねに文字列結果(空であっても)を返さなければならない.

パラメータ
private_key応力.応力

クライアント秘密鍵。

sender_id応力.応力

送信者共通ID。

msg_id応力.応力

受け取ったメールID。

messageディクト！

受け取った情報です。

返品
confirmation応力.応力

任意の確認文字列。

receive_notification(private_key, sender_id, message)[ソース]

標準的にクライアントを呼ぶことができる receive_notification 方法です。

メソッドの場合は，このメソッドを自動的に処理する. bind_receive_notification() 方法は，異なる操作をMTypeにバインドするために用いられる.カスタマイズされたクライアントが引継ぎを実現することができる場合 SAMPClient このような方法は書き換えられるべきである.

注釈

上書きされた場合，この方法はつねに文字列結果(空であっても)を返さなければならない.

パラメータ
private_key応力.応力

クライアント秘密鍵。

sender_id応力.応力

送信者共通ID。

messageディクト！

受け取った情報です。

返品
confirmation応力.応力

任意の確認文字列。

receive_response(private_key, responder_id, msg_tag, response)[ソース]

標準的にクライアントを呼ぶことができる receive_response 方法です。

メソッドの場合は，このメソッドを自動的に処理する. bind_receive_response() 方法は，異なる操作をMTypeにバインドするために用いられる.カスタマイズされたクライアントが引継ぎを実現することができる場合 SAMPClient このような方法は書き換えられるべきである.

注釈

上書きされた場合，この方法はつねに文字列結果(空であっても)を返さなければならない.

パラメータ
private_key応力.応力

クライアント秘密鍵。

responder_id応力.応力

応答者共通ID。

msg_tag応力.応力

メッセージタグに応答する。

responseディクト！

応答を受け取りました。

返品
confirmation応力.応力

任意の確認文字列。

register()[ソース]

クライアントをSAMPハブに登録する.

start()[ソース]

クライアントは単独のスレッド(非輻輳)で起動される.

これは以下の場合にのみ有効である callable 設定は True クライアントを初期化する際に.

stop(timeout=10.0)[ソース]

クライアントを停止する.

パラメータ
timeout浮いている.

タイムアウトは，このタイムアウト後，クライアントが完全にオフにならなければ破棄する.

unbind_receive_call(mtype, declare=True)[ソース]

呼び出し結束表から指定されたMTypeを削除し，クライアントの購読をキャンセルする(必要であれば).

パラメータ
mtype応力.応力

削除するMTypeです。

declareブルル.

クライアントがMTypeからの購読キャンセルとして自動的に宣言する必要があるかどうかを指定します(別途参照 declare_subscriptions() ）。

unbind_receive_notification(mtype, declare=True)[ソース]

指定されたMTypeを通知結束テーブルから削除し、必要に応じてクライアントの加入をキャンセルします。

パラメータ
mtype応力.応力

削除するMTypeです。

declareブルル.

クライアントがMTypeからの購読キャンセルとして自動的に宣言する必要があるかどうかを指定します(別途参照 declare_subscriptions() ）。

unbind_receive_response(msg_tag)[ソース]

指定されたメッセージタグは、応答結合テーブルから削除される。

パラメータ
msg_tag応力.応力

削除するメッセージタグ。

unregister()[ソース]

SAMPハブからクライアントの登録をキャンセルします。