Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

qmf.opcode field

Message Body Data Type

Sent By

Sent To

Description

_exception

QMF_DATA

Agent

reply-to

This general-purpose message can be sent by an agent in response to any request (query, subscription, method) if the request could not be completed for any reason. The QMF_DATA in the message body contains details of why the failure occurred.

_agent_locate_request

QMF_QUERY_PREDICATE

Console

QMF Topic

A console may send an agent-locate-request in order to reach all available agents. The predicate may be used to limit the set of agents that will respond to the request.

_agent_locate_response

QMF_DATA

Agent

reply-to

This is a response to an agent-locate-request. An agent will send an agent-locate-response if it received an agent-locate-request with a predicate that matches its characteristics.

_agent_heartbeat_indication

QMF_DATA

Agent

Topic

Each agent periodically sends a heartbeat message to a topic to indicate that it is alive and connected. The content of the heartbeat message is the list of the agent's characteristics.

_query_request

QMF_QUERY

Console

Agent

A console sends a query to an agent to request that the agent send data to the requester.

_query_response

List of <qmf.content>

Agent

reply-to

The response to a query sent by a console.

_subscribe_request

QMF_SUBSCRIBE

Console

Agent

A console sends a subscribe-request to an agent to receive data matched by a query. A subscription differs from a query request in that it continues to send updated information to the console when the data changes.

_subscribe_response

QMF_SUBSCRIPTION

Agent

reply-to

When an agent receives a subscribe-request, it sends a subscribe-response granting (or refusing) the subscription.  Should the subscription succeed, the response will contain an identifier for the subscription assigned by the Agent. Thereafter, it will send data-indication messages on the same correlation-id with updates when they happen or periodically.  The first data-indication message sent by the agent will contain all matching data, subsequent data-indications will contain only those matching data that has changed since the last update.

_subscribe_cancel_indication

QMF_SUBSCRIPTION_ID

Console

Agent

A console can request that a subscription that it requested created be immediately cancelled. This message must have the same correlation-id as the original request, and contain the subscription identifier as assigned by the Agent.

_subscribe_refresh_request indication

QMF_SUBSCRIPTION_ID

Console

Agent

A console can keep a subscription alive by periodically refreshing it by sending a subscribe-refresh-requestindication. This message must have the same correlation-id as the original request.  The QMF_SUBSCRIPTION must , and contain the subscription identifier as assigned to the subscription by the Agent.

_subscribedata_refresh_response
QMF_SUBSCRIPTION indication

List of <qmf.content>

Agent

reply-to

When an agent receives a subscribe-refresh-request, it sends a subscribe-refresh-response granting (or refusing) the subscription refresh.   

or topic

A data indication is sent by an Agent when 1) subscription data

_data_indication

List of <qmf.content>

Agent

reply-to or topic

A data indication is sent by an Agent when 1) subscription data has changed and needs to be published, 2) an event has occurred and event data is being published, and 3) any other time an agent wants to send unsolicited data.

_method_request

QMF_METHOD_CALL

Console

Agent

A console may invoke a method on an object managed by an agent. It may also invoke a method directly on the agent if appropriate. This message contains the method call including the input arguments.

_method_response

QMF_METHOD_RESULT

Agent

reply-to

A method call always results in a single method result. This message carries either the output arguments from a successful method call or it holds an exception to describe a failure.

...

Field

Optional

Description

_subscription_id

yes

Assigned by the Agent when replying to a successful subscription request. Must be supplied by the Console when sending a subscription refresh or cancel to the Agent for this subscription. Should the request fail, the Agent should not supply this field, and may set the _error field.

_duration

no

_duration

no

The time (in seconds) after which this subscription will be automatically canceled.

_interval

no

The time (in milliseconds) between periodic updates of data in this subscription.

...

No Format
QMF_SUBSCRIPTION_ID := { _subscription_id:     STRING,
                         _duration:  NUMBER
                       }

Field

Optional

Description

_subscription_id

no

Supplied by the Console when sending a subscription refresh or cancel to the Agent for this subscription.

_duration

yes

May be supplied in a subscription refresh request to request a new duration for the subscription. If not present, the Agent will use the subscription's original duration.