SAMP â Simple Application Messag- ing Protocol Version 1.11 - IVOA

More documents

Recommendations

Info

5.4 Core MTypesThis section defines those MTypes currently in the “samp.” hierarchy. Theseare the “administrative”-type MTypes which are core to the SAMP architectureor widely applicable to SAMP applications.5.4.1 Hub Administrative MessagesThe following MTypes are for messages which SHOULD be broadcast by thehub in response to changes in hub state. By subscribing to these messages,clients are able to keep track of the current set of registered applications andof their metadata and subscriptions. In general, non-hub clients SHOULDNOT send these messages.samp.hub.event.shutdown:Arguments:noneReturn Values:noneDescription:The hub SHOULD broadcast this message just before it exits.The hub SHOULD make every effort to broadcast this messageeven in case of an exit due to an error condition.samp.hub.event.register:Arguments:id (string) — Public ID of newly registered clientReturn Values:noneDescription:The hub SHOULD broadcast this message every time a clientsuccessfully registers.samp.hub.event.unregister:Arguments:id (string) — public ID of unregistered clientReturn Values:noneDescription:The hub SHOULD broadcast this message every time a clientunregisters.34
samp.hub.event.metadata:Arguments:id (string) — public ID of client declaring metadatametadata (map) — new metadata declared by clientReturn Values:noneDescription:The hub SHOULD broadcast this message every time a client declaresits metadata. The metadata argument is exactly as passedusing the declareMetadata() method.samp.hub.event.subscriptions:Arguments:id (string) — public ID of subscribing clientsubscriptions (map) — new subscriptions declared by clientReturn Values:noneDescription:The hub SHOULD broadcast this message every time a client declaresits subscriptions. The subscriptions argument is exactlyas passed using the declareSubscriptions() method, and hencemay contain wildcarded MType strings.samp.hub.disconnect:Arguments:reason (string) — (OPTIONAL) Short text message indicatingthe reason that the disconnection is being forcedReturn Values:noneDescription:The hub SHOULD send this message to a client if the hub intendsto disconnect that client forcibly. This indicates that no furthercommunication from that client is welcome, and any such attemptsmay be expected to fail. The hub may wish to disconnect clientsforcibly as a result of some hub timeout policy or for other reasons.5.4.2 Client Administrative MessagesThe following messages are generic messages defined for client use.35
Page 5 and 6: not discussed further in this docum
Page 7 and 8: Recipient: A Client that receives a
Page 9 and 10: 3. Await client registrations. When
Page 11 and 12: consumers if appropriate. As far as
Page 13 and 14: Although SAMP imposes no maximum on
Page 15 and 16: SAMP operation, but they are there
Page 17 and 18: These keys form the basis of an ext
Page 19 and 20: Figure 2: Notification pattern2. Th
Page 21 and 22: protection from this eventuality; u
Page 23 and 24: Sends a message using the Synchrono
Page 25 and 26: 4.1 Data Type MappingsThe SAMP argu
Page 27 and 28: ::= [a-zA-Z0-9] | "-" | "_" | "." :
Page 29 and 30: string hub-url = readFromLockfile("
Page 31 and 32: dummy.version0.1-3The message itsel
Page 33: For each of the named parameters, a
Page 37 and 38: Return Values:noneDescription:Repor
Page 39 and 40: offers benefits such as meaning tha
Page 41: [6] http://plastic.sourceforge.net/

SAMP â Simple Application Messag- ing Protocol Version 1.11 - IVOA

Create successful ePaper yourself

Delete template?

Save as template?

SAMP â Simple Application Messag- ing Protocol Version 1.11 - IVOA