API Documentation

• spade package
  • Submodules
  • spade.agent module
    • Agent
      • Agent.add_behaviour()
      • Agent.avatar
      • Agent.behaviours
      • Agent.build_avatar_url()
      • Agent.client
      • Agent.container
      • Agent.dispatch()
      • Agent.get()
      • Agent.has_behaviour()
      • Agent.is_alive()
      • Agent.jid
      • Agent.loop
      • Agent.name
      • Agent.password
      • Agent.presence
      • Agent.remove_behaviour()
      • Agent.set()
      • Agent.set_container()
      • Agent.set_loop()
      • Agent.setup()
      • Agent.start()
      • Agent.stop()
      • Agent.submit()
      • Agent.traces
      • Agent.verify_security
      • Agent.web
      • Agent.xmpp_port
    • AuthenticationFailure
    • DisconnectedException
  • spade.behaviour module
    • BehaviourNotFinishedException
    • CyclicBehaviour
      • CyclicBehaviour.agent
      • CyclicBehaviour.download_file()
      • CyclicBehaviour.enqueue()
      • CyclicBehaviour.exit_code
      • CyclicBehaviour.get()
      • CyclicBehaviour.is_done()
      • CyclicBehaviour.is_killed()
      • CyclicBehaviour.is_running
      • CyclicBehaviour.join()
      • CyclicBehaviour.kill()
      • CyclicBehaviour.mailbox_size()
      • CyclicBehaviour.match()
      • CyclicBehaviour.on_end
      • CyclicBehaviour.on_start
      • CyclicBehaviour.presence
      • CyclicBehaviour.queue
      • CyclicBehaviour.receive()
      • CyclicBehaviour.run()
      • CyclicBehaviour.send()
      • CyclicBehaviour.send_file()
      • CyclicBehaviour.set()
      • CyclicBehaviour.set_agent()
      • CyclicBehaviour.set_template()
      • CyclicBehaviour.start()
      • CyclicBehaviour.template
      • CyclicBehaviour.upload_and_send_file()
      • CyclicBehaviour.upload_file()
      • CyclicBehaviour.web
    • FSMBehaviour
      • FSMBehaviour.add_state()
      • FSMBehaviour.add_transition()
      • FSMBehaviour.current_state
      • FSMBehaviour.get_state()
      • FSMBehaviour.get_states()
      • FSMBehaviour.is_valid_transition()
      • FSMBehaviour.run()
      • FSMBehaviour.setup
      • FSMBehaviour.to_graphviz()
    • NotValidState
    • NotValidTransition
    • OneShotBehaviour
    • PeriodicBehaviour
      • PeriodicBehaviour.period
    • State
      • State.next_state
      • State.receive
      • State.set_next_state()
    • TimeoutBehaviour
    • now()
  • spade.cli module
    • check_port_in_use()
    • create_cli()
  • spade.container module
    • Container
    • get_or_create_eventloop()
    • run_container()
  • spade.fipa_message module
    • FIPAMessageBuilder
      • FIPAMessageBuilder.LANGUAGES
      • FIPAMessageBuilder.PERFORMATIVES
      • FIPAMessageBuilder.PROTOCOLS
      • FIPAMessageBuilder.build()
      • FIPAMessageBuilder.create_inform_message()
      • FIPAMessageBuilder.create_request_message()
      • FIPAMessageBuilder.create_response_message()
      • FIPAMessageBuilder.message
      • FIPAMessageBuilder.metadata
      • FIPAMessageBuilder.set_body()
      • FIPAMessageBuilder.set_conversation_id()
      • FIPAMessageBuilder.set_custom_metadata()
      • FIPAMessageBuilder.set_in_reply_to()
      • FIPAMessageBuilder.set_language()
      • FIPAMessageBuilder.set_ontology()
      • FIPAMessageBuilder.set_performative()
      • FIPAMessageBuilder.set_protocol()
      • FIPAMessageBuilder.set_reply_by()
    • FIPAMessageParser
      • FIPAMessageParser.get_conversation_id()
      • FIPAMessageParser.get_custom_metadata()
      • FIPAMessageParser.get_language()
      • FIPAMessageParser.get_ontology()
      • FIPAMessageParser.get_performative()
      • FIPAMessageParser.get_protocol()
      • FIPAMessageParser.get_reply_with()
      • FIPAMessageParser.is_valid_fipa_message()
      • FIPAMessageParser.message
      • FIPAMessageParser.metadata
      • FIPAMessageParser.parse_body()
      • FIPAMessageParser.print_debug_info()
      • FIPAMessageParser.validate_fipa_message()
    • InvalidPerformativeError
      • InvalidPerformativeError.performative
      • InvalidPerformativeError.valid_performatives
    • PerformativeNotSetError
  • spade.message module
    • Message
      • Message.make_reply()
      • Message.prepare()
      • Message.sent
    • MessageBase
      • MessageBase.body
      • MessageBase.empty_jid()
      • MessageBase.empty_sender()
      • MessageBase.empty_to()
      • MessageBase.from_node()
      • MessageBase.get_metadata()
      • MessageBase.id
      • MessageBase.match()
      • MessageBase.sender
      • MessageBase.sent
      • MessageBase.set_metadata()
      • MessageBase.thread
      • MessageBase.to
  • spade.presence module
    • Contact
      • Contact.ask
      • Contact.current_presence
      • Contact.get_presence()
      • Contact.groups
      • Contact.is_available()
      • Contact.is_subscribed()
      • Contact.jid
      • Contact.last_presence
      • Contact.name
      • Contact.resources
      • Contact.subscription
      • Contact.update_presence()
      • Contact.update_subscription()
    • ContactNotFound
    • PresenceInfo
      • PresenceInfo.is_available()
      • PresenceInfo.priority
      • PresenceInfo.show
      • PresenceInfo.status
      • PresenceInfo.type
    • PresenceManager
      • PresenceManager.agent
      • PresenceManager.approve_all
      • PresenceManager.approve_subscription()
      • PresenceManager.contacts
      • PresenceManager.current_presence
      • PresenceManager.get_contact()
      • PresenceManager.get_contact_presence()
      • PresenceManager.get_contacts()
      • PresenceManager.get_presence()
      • PresenceManager.get_priority()
      • PresenceManager.get_show()
      • PresenceManager.get_status()
      • PresenceManager.handle_presence()
      • PresenceManager.handle_roster_update()
      • PresenceManager.handle_subscription()
      • PresenceManager.is_available()
      • PresenceManager.on_available
      • PresenceManager.on_presence_received
      • PresenceManager.on_subscribe
      • PresenceManager.on_subscribed
      • PresenceManager.on_unavailable
      • PresenceManager.on_unsubscribe
      • PresenceManager.on_unsubscribed
      • PresenceManager.set_available()
      • PresenceManager.set_presence()
      • PresenceManager.set_unavailable()
      • PresenceManager.subscribe()
      • PresenceManager.subscribed()
      • PresenceManager.unsubscribe()
      • PresenceManager.unsubscribed()
    • PresenceNotFound
    • PresenceShow
      • PresenceShow.AWAY
      • PresenceShow.CHAT
      • PresenceShow.DND
      • PresenceShow.EXTENDED_AWAY
      • PresenceShow.NONE
    • PresenceType
      • PresenceType.AVAILABLE
      • PresenceType.ERROR
      • PresenceType.PROBE
      • PresenceType.SUBSCRIBE
      • PresenceType.SUBSCRIBED
      • PresenceType.UNAVAILABLE
      • PresenceType.UNSUBSCRIBE
      • PresenceType.UNSUBSCRIBED
  • spade.template module
    • ANDTemplate
      • ANDTemplate.expr1
      • ANDTemplate.expr2
      • ANDTemplate.match()
    • BaseTemplate
    • NOTTemplate
      • NOTTemplate.expr
      • NOTTemplate.match()
    • ORTemplate
      • ORTemplate.expr1
      • ORTemplate.expr2
      • ORTemplate.match()
    • Template
      • Template.sent
    • XORTemplate
      • XORTemplate.expr1
      • XORTemplate.expr2
      • XORTemplate.match()
  • spade.trace module
    • TraceStore
      • TraceStore.all()
      • TraceStore.append()
      • TraceStore.filter()
      • TraceStore.len()
      • TraceStore.received()
      • TraceStore.reset()
      • TraceStore.size
      • TraceStore.store
  • spade.web module
    • WebApp
      • WebApp.add_get()
      • WebApp.add_menu_entry()
      • WebApp.add_post()
      • WebApp.add_template_path()
      • WebApp.agent
      • WebApp.agent_processor()
      • WebApp.app
      • WebApp.find_behaviour()
      • WebApp.get_agent()
      • WebApp.get_behaviour()
      • WebApp.get_messages()
      • WebApp.hostname
      • WebApp.index()
      • WebApp.is_started()
      • WebApp.kill_behaviour()
      • WebApp.loaders
      • WebApp.menu_entries
      • WebApp.port
      • WebApp.runner
      • WebApp.send_agent()
      • WebApp.server
      • WebApp.setup_routes()
      • WebApp.start()
      • WebApp.stop_agent()
      • WebApp.stop_now()
      • WebApp.timeago()
      • WebApp.unsubscribe_agent()
    • start_server_in_loop()
    • unused_port()
  • spade.xmpp_client module
    • RegistrationException
    • XMPPClient
      • XMPPClient.register()
      • XMPPClient.session_start()
  • Module contents