Jadex 0.96

jadex.planlib
Capability ProtocolsMobile


capability ProtocolsMobile

The protocols capability enables an easy goal-driven usage of some often used FIPA protocols.


Belief Summary
exported belief IFilter rp_filter
           The filter for deciding which initial request messages are handled in this capability (not yet supported).
exported belief Long timeout
           Timeout for messages.
 
Goal Summary
exported achievegoal rp_initiate(Object content, String language, String ontology, AgentIdentifier receiver, Object result, Long timeout)
           Initiate a conversation using the fipa-request protocol.
 
Plan Summary
mobile plan request_initiator_plan(Object content, String language, String ontology, AgentIdentifier receiver, Object result, String timeout)
          
 
Event Summary
exported messageevent rp_agree(String language, String performative, String protocol)
          
exported messageevent rp_failure(String language, String performative, String protocol)
          
exported messageevent rp_inform_done(String language, String performative, String protocol)
          
exported messageevent rp_not_understood(String language, String performative, String protocol)
          
exported messageevent rp_refuse(String language, String performative, String protocol)
          
exported messageevent rp_request(String conversation-id, String language, String performative, String protocol, String reply-with)
          
 

Belief Detail

timeout

exported belief Long timeout
Timeout for messages.

Default fact:
(Integer)$propertybase.getProperty("standard.timeout")

rp_filter

exported belief IFilter rp_filter
The filter for deciding which initial request messages are handled in this capability (not yet supported).

Default fact:
IFilter.NEVER
Goal Detail

rp_initiate

exported achievegoal rp_initiate(Object content, 
                                 String language, 
                                 String ontology, 
                                 AgentIdentifier receiver, 
                                 Object result, 
                                 Long timeout)
Initiate a conversation using the fipa-request protocol.

Parameters:
in parameter content
optional in parameter language
optional in parameter ontology
in parameter receiver
out parameter result
optional in parameter timeout
BDI flags:
retry: true
retry delay: 0
exclude: when_tried
random selection: false
post to all: false
Plan Detail

request_initiator_plan

mobile plan request_initiator_plan(Object content, 
                                  String language, 
                                  String ontology, 
                                  AgentIdentifier receiver, 
                                  Object result, 
                                  String timeout)
Parameters:
in parameter content (goal mappings: rp_initiate.content)
in parameter language (goal mappings: rp_initiate.language)
in parameter ontology (goal mappings: rp_initiate.ontology)
in parameter receiver (goal mappings: rp_initiate.receiver)
out parameter result (goal mappings: rp_initiate.result)
in parameter timeout (goal mappings: rp_initiate.timeout)
Plan body:
Plan trigger:
Goals:
rp_initiate
Event Detail

rp_request

exported messageevent rp_request(String conversation-id, 
                                 String language, 
                                 String performative, 
                                 String protocol, 
                                 String reply-with)
Parameters:
in parameter conversation-id Default value:  SFipa.createUniqueId($scope.getAgentName())
in parameter language Default value:  SFipa.NUGGETS_XML
fixed parameter performative Default value:  SFipa.REQUEST
fixed parameter protocol Default value:  SFipa.PROTOCOL_REQUEST
in parameter reply-with Default value:  SFipa.createUniqueId($scope.getAgentName())
Event flags:
direction: send_receive
message type: fipa
random selection: false
post to all: false

rp_agree

exported messageevent rp_agree(String language, 
                               String performative, 
                               String protocol)
Parameters:
in parameter language Default value:  SFipa.NUGGETS_XML
fixed parameter performative Default value:  SFipa.AGREE
fixed parameter protocol Default value:  SFipa.PROTOCOL_REQUEST
Event flags:
direction: send_receive
message type: fipa
random selection: false
post to all: false

rp_refuse

exported messageevent rp_refuse(String language, 
                                String performative, 
                                String protocol)
Parameters:
in parameter language Default value:  SFipa.NUGGETS_XML
fixed parameter performative Default value:  SFipa.REFUSE
fixed parameter protocol Default value:  SFipa.PROTOCOL_REQUEST
Event flags:
direction: send_receive
message type: fipa
random selection: false
post to all: false

rp_failure

exported messageevent rp_failure(String language, 
                                 String performative, 
                                 String protocol)
Parameters:
in parameter language Default value:  SFipa.NUGGETS_XML
fixed parameter performative Default value:  SFipa.FAILURE
fixed parameter protocol Default value:  SFipa.PROTOCOL_REQUEST
Event flags:
direction: send_receive
message type: fipa
random selection: false
post to all: false

rp_not_understood

exported messageevent rp_not_understood(String language, 
                                        String performative, 
                                        String protocol)
Parameters:
in parameter language Default value:  SFipa.NUGGETS_XML
fixed parameter performative Default value:  SFipa.NOT_UNDERSTOOD
fixed parameter protocol Default value:  SFipa.PROTOCOL_REQUEST
Event flags:
direction: send_receive
message type: fipa
random selection: false
post to all: false

rp_inform_done

exported messageevent rp_inform_done(String language, 
                                     String performative, 
                                     String protocol)
Parameters:
in parameter language Default value:  SFipa.NUGGETS_XML
- Done.class
fixed parameter performative Default value:  SFipa.INFORM
fixed parameter protocol Default value:  SFipa.PROTOCOL_REQUEST
Event flags:
direction: send_receive
message type: fipa
random selection: false
post to all: false

Jadex 0.96

Submit a bug or feature
For further API reference and developer documentation, see the Jadex User Guide and the Jadex Tutorial. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, and working code examples.

Copyright (C) 2002-2007 Lars Braubach, Alexander Pokahr - University of Hamburg. Use is subject to license terms.