SAMPIntegratedClient

class astropy.samp.SAMPIntegratedClient(name=None, description=None, metadata=None, addr=None, port=0, callable=True)

ベースクラス: object

簡単なSAMPクライアントです

このようなクライアントの使用を簡略化することを目的とし、エージェントクラスを統合するエージェントクラスを提供する。 SAMPClient そして SAMPHubProxy 簡略化されたAPIにおける機能.

パラメータ

name文字列、オプション

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

description文字列、オプション

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

metadataDICT、オプション

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

addr文字列、オプション

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

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

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

callableブル値、オプション

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

属性要約

is_connected \

クライアントと実行中のハブとの接続のテスト方法を検証する.

方法要約

bind_receive_call \(mtype，関数[, ...] )	特定のMType呼び出しを関数やクラスメソッドにバインドする.
bind_receive_message \(mtype，関数[, ...] )	特定のMTypeを呼び出しまたは通知のための関数またはクラスメソッドにバインドします。
bind_receive_notification \(mtype，関数[, ...] )	特定のMType通知を関数やクラスメソッドにバインドする.
bind_receive_response (メッセージ_タグ，関数)	特定のmsg−tag応答を関数またはクラス方法にバインドする。
call (受信者_id，メッセージ_タグ，メッセージ)	代理が来る call Samp Hub方法。
call_all \(メッセージ_タグ，メッセージ)	代理が来る callAll Samp Hub方法。
call_and_wait (宛先_id，メール，タイムアウト)	代理が来る callAndWait Samp Hub方法。
connect \([hub, hub_params, pool_size] )	現在または指定されたSAMPハブに接続し、クライアントを起動して登録する。
declare_metadata \(メタデータ)	代理が来る declareMetadata Samp Hub方法。
declare_subscriptions \([subscriptions] )	クライアントが購読したいMTypesを宣言し，MTypeバインディング方法を用いて暗黙的に定義する. bind_receive_notification() そして bind_receive_call() それがそうです。
disconnect \()	現在のSAMPハブからクライアントをログアウトし、クライアントを停止し、ハブとの接続を切断する。
ecall (受信者_id，メッセージ_タグ，mtype，** パラメータ)	使いやすいバージョン call() それがそうです。
ecall_all \(メッセージ_タグ，mtype，** パラメータ)	使いやすいバージョン call_all() それがそうです。
ecall_and_wait (宛先_id，mtype，タイムアウト，...)	使いやすいバージョン call_and_wait() それがそうです。
enotify (宛先_id，mtype，** パラメータ)	使いやすいバージョン notify() それがそうです。
enotify_all \(mtype，** パラメータ)	使いやすいバージョン notify_all() それがそうです。
ereply \(メッセージ_id，状態[, result, error] )	使いやすいバージョン reply() それがそうです。
get_metadata \(クライアント_id)	代理が来る getMetadata Samp Hub方法。
get_private_key \()	登録時に得られた標準プロファイル通信のためのクライアント秘密鍵を返す. (samp.private-key ）。
get_public_id \()	登録時に取得したパブリッククライアントIDを返す (samp.self-id ）。
get_registered_clients \()	代理が来る getRegisteredClients Samp Hub方法。
get_subscribed_clients \(mtype)	代理が来る getSubscribedClients Samp Hub方法。
get_subscriptions \(クライアント_id)	代理が来る getSubscriptions Samp Hub方法。
notify (宛先_id，メール)	代理が来る notify Samp Hub方法。
notify_all \(メッセージ)	代理が来る notifyAll Samp Hub方法。
ping \()	代理が来る ping サンプリングハブ方法(標準輪郭のみ)。
receive_call (秘密鍵_鍵，送信者_id，メッセージ_id，...)	標準的にクライアントを呼ぶことができる receive_call 方法です。
receive_notification \(プライベート_鍵，送信者_id，...)	標準的にクライアントを呼ぶことができる receive_notification 方法です。
receive_response \(プライベート_キー，応答者_id，...)	標準的にクライアントを呼ぶことができる receive_response 方法です。
reply \(メッセージ_id，レスポンス)	代理が来る reply Samp Hub方法。
unbind_receive_call \(mtype[, declare] )	呼び出し結束表から指定されたMTypeを削除し，クライアントの購読をキャンセルする(必要であれば).
unbind_receive_notification \(mtype[, declare] )	指定されたMTypeを通知結束テーブルから削除し、必要に応じてクライアントの加入をキャンセルします。
unbind_receive_response \(メッセージ_タグ)	指定されたメッセージタグは、応答結合テーブルから削除される。

属性文書

is_connected

クライアントと実行中のハブとの接続のテスト方法を検証する.

返品

is_connectedブルル.

クライアントがハブに接続されていればTrue，そうでなければFalseとなる.

方法文書

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 受け取りました。

call(recipient_id, msg_tag, message)

代理が来る call Samp Hub方法。

call_all(msg_tag, message)

代理が来る callAll Samp Hub方法。

call_and_wait(recipient_id, message, timeout)

代理が来る callAndWait Samp Hub方法。

connect(hub=None, hub_params=None, pool_size=20)

現在または指定されたSAMPハブに接続し、クライアントを起動して登録する。

パラメータ

hub ： SAMPHubServer オプションです。SAMPHubServer、オプション

接続するハブ。

hub_paramsDICT、オプション

接続するハブのロックファイルの内容を含むオプション辞書.この辞書の形式は {{<token-name>: <token-string>, ...}} それがそうです。

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

ハブと通信するために開いたソケット接続数.

declare_metadata(metadata)

代理が来る declareMetadata Samp Hub方法。

declare_subscriptions(subscriptions=None)

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

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

パラメータ

subscriptionsDICT、オプション

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

disconnect()

現在のSAMPハブからクライアントをログアウトし、クライアントを停止し、ハブとの接続を切断する。

ecall(recipient_id, msg_tag, mtype, **params)

使いやすいバージョン call() それがそうです。

これは代理です call 方法は、簡略化された方法で呼メッセージを送信することを可能にする。

注意してください。保留してください。 extra_kws キーワードは辞書であり、その特殊な意味は、標準に基づいて追加のキーワードを追加することである samp.mtype そして samp.params 、送信されたメッセージ。

パラメータ

recipient_id応力.応力

受取人ID

msg_tag応力.応力

使用するメッセージタグ

mtype応力.応力

送信するmType

params文字列集合の辞書

Variableキーセットは，MTypeを指定するパラメータリストを含む.

実例.

>>> from astropy.samp import SAMPIntegratedClient
>>> cli = SAMPIntegratedClient()
>>> ...
>>> msgid = cli.ecall("abc", "xyz", "samp.msg.progress",
...                   txt = "initialization", percent = "10",
...                   extra_kws = {"my.extra.info": "just an example"})

ecall_all(msg_tag, mtype, **params)

使いやすいバージョン call_all() それがそうです。

これは代理です callAll 方法は、簡略化された方法で呼メッセージを送信することを可能にする。

注意してください。保留してください。 extra_kws キーワードは辞書であり、その特殊な意味は、標準に基づいて追加のキーワードを追加することである samp.mtype そして samp.params 、送信されたメッセージ。

パラメータ

msg_tag応力.応力

使用するメッセージタグ

mtype応力.応力

送信するmType

params文字列集合の辞書

Variableキーセットは，MTypeを指定するパラメータリストを含む.

実例.

>>> from astropy.samp import SAMPIntegratedClient
>>> cli = SAMPIntegratedClient()
>>> ...
>>> msgid = cli.ecall_all("xyz", "samp.msg.progress",
...                       txt = "initialization", percent = "10",
...                       extra_kws = {"my.extra.info": "just an example"})

ecall_and_wait(recipient_id, mtype, timeout, **params)

使いやすいバージョン call_and_wait() それがそうです。

これは代理です callAndWait 方法は、簡略化された方法で呼メッセージを送信することを可能にする。

注意してください。保留してください。 extra_kws キーワードは辞書であり、その特殊な意味は、標準に基づいて追加のキーワードを追加することである samp.mtype そして samp.params 、送信されたメッセージ。

パラメータ

recipient_id応力.応力

受取人ID

mtype応力.応力

送信するmType

timeout応力.応力

呼び出しがタイムアウトした

params文字列集合の辞書

Variableキーセットは，MTypeを指定するパラメータリストを含む.

実例.

>>> from astropy.samp import SAMPIntegratedClient
>>> cli = SAMPIntegratedClient()
>>> ...
>>> cli.ecall_and_wait("xyz", "samp.msg.progress", "5",
...                    txt = "initialization", percent = "10",
...                    extra_kws = {"my.extra.info": "just an example"})

enotify(recipient_id, mtype, **params)

使いやすいバージョン notify() それがそうです。

これは代理です notify 方法は、簡略化された方法で通知メッセージを送信することを可能にする。

注意してください。保留してください。 extra_kws キーワードは辞書であり、その特殊な意味は、標準に基づいて追加のキーワードを追加することである samp.mtype そして samp.params 、送信されたメッセージ。

パラメータ

recipient_id応力.応力

受取人ID

mtype応力.応力

お知らせするMType

params辞書や文字列集

Variableキーセットは，MTypeを指定するパラメータリストを含む.

実例.

>>> from astropy.samp import SAMPIntegratedClient
>>> cli = SAMPIntegratedClient()
>>> ...
>>> cli.enotify("samp.msg.progress", msgid = "xyz", txt = "initialization",
...             percent = "10", extra_kws = {"my.extra.info": "just an example"})

enotify_all(mtype, **params)

使いやすいバージョン notify_all() それがそうです。

これは代理です notifyAll 方法は、簡略化された方法で通知メッセージを送信することを可能にする。

注意してください。保留してください。 extra_kws キーワードは辞書であり、その特殊な意味は、標準に基づいて追加のキーワードを追加することである samp.mtype そして samp.params 、送信されたメッセージ。

パラメータ

mtype応力.応力

お知らせするMTypeです。

params辞書や文字列集

Variableキーセットは，MTypeを指定するパラメータリストを含む.

実例.

>>> from astropy.samp import SAMPIntegratedClient
>>> cli = SAMPIntegratedClient()
>>> ...
>>> cli.enotify_all("samp.msg.progress", txt = "initialization",
...                 percent = "10",
...                 extra_kws = {"my.extra.info": "just an example"})

ereply(msg_id, status, result=None, error=None)

使いやすいバージョン reply() それがそうです。

これは代理です reply 方法は、簡略化された方法で応答メッセージを送信することを可能にする。

パラメータ

msg_id応力.応力

返信されたメッセージID。

status応力.応力

の内容 samp.status キーワードに応答する。

resultディクト！

の内容 samp.result キーワードに応答する。

errorディクト！

の内容 samp.error キーワードに応答する。

実例.

>>> from astropy.samp import SAMPIntegratedClient, SAMP_STATUS_ERROR
>>> cli = SAMPIntegratedClient()
>>> ...
>>> cli.ereply("abd", SAMP_STATUS_ERROR, result={},
...            error={"samp.errortxt": "Test error message"})

get_metadata(client_id)

代理が来る getMetadata Samp Hub方法。

get_private_key()

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

返品

key応力.応力

クライアント秘密鍵。

get_public_id()

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

返品

id応力.応力

クライアント共通ID。

get_registered_clients()

代理が来る getRegisteredClients Samp Hub方法。

これは、現在のクライアントを除くすべての登録されたクライアントに戻る。

get_subscribed_clients(mtype)

代理が来る getSubscribedClients Samp Hub方法。

get_subscriptions(client_id)

代理が来る getSubscriptions Samp Hub方法。

notify(recipient_id, message)

代理が来る notify Samp Hub方法。

notify_all(message)

代理が来る notifyAll Samp Hub方法。

ping()

代理が来る ping サンプリングハブ方法(標準輪郭のみ)。

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応力.応力

任意の確認文字列。

reply(msg_id, response)

代理が来る reply Samp Hub方法。

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応力.応力

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