Jadex 0.96

jadex.planlib
Capability Ping


capability Ping

The ping capability helps integrating ping behaviour for agents.


Belief Summary
exported belief String ping_answer
          
exported belief String ping_content
          
exported belief long ping_delay
          
exported abstract beliefref AgentIdentifier ping_receiver
          
exported belief Long ping_timeout
          
 
Goal Summary
exported achievegoal ping(String content, AgentIdentifier receiver, Long timeout)
          
 
Plan Summary
standard plan answer_ping()
           This plan sends back an alive on a ping request.
standard plan do_ping(String content, AgentIdentifier receiver, long timeout)
           This plan initiates a ping request.
standard plan pinging()
           Initial plan that continually send ping messages to another agent.
 
Event Summary
exported messageevent custom_query_ping(String performative, String reply-with)
           Custom query ping message events.
exported messageevent default_query_ping(String content, String performative, String reply-with)
           Default query ping message events.
exported messageevent inform_alive(String content, String performative)
           Ping queries are answered with an inform message.
exported messageevent query_ping(String content, String performative)
           Query ping message events must match performative=query_ref and content="ping".
 
Configuration Summary
default configuration  ping
          
configuration  pinging
          
 

Belief Detail

ping_timeout

exported belief Long ping_timeout
Default fact:
1000

ping_delay

exported belief long ping_delay
Default fact:
1000

ping_content

exported belief String ping_content
Default fact:
"ping"

ping_answer

exported belief String ping_answer
Default fact:
"alive"

ping_receiver

exported abstract beliefref AgentIdentifier ping_receiver
Goal Detail

ping

exported achievegoal ping(String content, 
                          AgentIdentifier receiver, 
                          Long timeout)
Parameters:
in parameter content Default value:  $beliefbase.ping_content
in parameter receiver Default value:  $beliefbase.getBelief("ping_receiver").isAccessible()? $beliefbase.ping_receiver: null
in parameter timeout Default value:  $beliefbase.ping_timeout
BDI flags:
retry: true
retry delay: 0
exclude: when_tried
random selection: false
post to all: false
Plan Detail

answer_ping

standard plan answer_ping()
This plan sends back an alive on a ping request.

Plan body:
Plan trigger:
Message events:
query_ping

do_ping

standard plan do_ping(String content, 
                     AgentIdentifier receiver, 
                     long timeout)
This plan initiates a ping request.

Parameters:
in parameter content (goal mappings: ping.content)
in parameter receiver (goal mappings: ping.receiver)
in parameter timeout Default value:  0
 (goal mappings: ping.timeout)
Plan body:
Plan trigger:
Goals:
ping

pinging

standard plan pinging()
Initial plan that continually send ping messages to another agent.

Plan body:
Event Detail

query_ping

exported messageevent query_ping(String content, 
                                 String performative)
Query ping message events must match performative=query_ref and content="ping".

Parameters:
fixed parameter content Default value:  $beliefbase.ping_content
fixed parameter performative Default value:  SFipa.QUERY_REF
Event flags:
direction: receive
message type: fipa
random selection: false
post to all: false

custom_query_ping

exported messageevent custom_query_ping(String performative, 
                                        String reply-with)
Custom query ping message events.

Parameters:
fixed parameter performative Default value:  SFipa.QUERY_REF
in parameter reply-with Default value:  SFipa.createUniqueId($scope.getAgentName())
Event flags:
direction: send
message type: fipa
random selection: false
post to all: false

default_query_ping

exported messageevent default_query_ping(String content, 
                                         String performative, 
                                         String reply-with)
Default query ping message events.

Parameters:
fixed parameter content Default value:  $beliefbase.ping_content
fixed parameter performative Default value:  SFipa.QUERY_REF
in parameter reply-with Default value:  SFipa.createUniqueId($scope.getAgentName())
Event flags:
direction: send
message type: fipa
random selection: false
post to all: false

inform_alive

exported messageevent inform_alive(String content, 
                                   String performative)
Ping queries are answered with an inform message.

Parameters:
in parameter content Default value:  $beliefbase.ping_answer
fixed parameter performative Default value:  SFipa.INFORM
Event flags:
direction: send_receive
message type: fipa
random selection: false
post to all: false
Configuration Detail

ping

default configuration ping

pinging

configuration pinging
Initial Plans:
pinging

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.