• Places
    • Home
    • Graphs
    • Prefixes
  • Admin
    • Users
    • Settings
    • Plugins
    • Statistics
  • Repository
    • Load local file
    • Load from HTTP
    • Load from library
    • Remove triples
    • Clear repository
  • Query
    • YASGUI SPARQL Editor
    • Simple Form
  • Help
    • Documentation
    • Tutorial
    • Roadmap
    • HTTP Services
  • Login

/usr/lib/swi-prolog/library/stomp.pl
All Application Manual Name SummaryHelp

  • swi-prolog
    • library
      • filesex.pl -- Extended operations on files
      • predicate_options.pl -- Access and analyse predicate options
      • shlib.pl -- Utility library for loading foreign objects (DLLs, shared objects)
      • doc_http.pl -- Documentation server
      • pldoc.pl -- Process source documentation
      • debug.pl -- Print debug messages and test assertions
      • lists.pl -- List Manipulation
      • apply.pl -- Apply predicates on a list
      • operators.pl -- Manage operators
      • error.pl -- Error generating support
      • pairs.pl -- Operations on key-value lists
      • option.pl -- Option list processing
      • prolog_source.pl -- Examine Prolog source-files
      • socket.pl -- Network socket (TCP and UDP) library
      • thread_pool.pl -- Resource bounded thread management
      • gensym.pl -- Generate unique symbols
      • settings.pl -- Setting management
      • arithmetic.pl -- Extensible arithmetic
      • broadcast.pl -- Event service
      • sgml.pl -- SGML, XML and HTML parser
      • quasi_quotations.pl -- Define Quasi Quotation syntax
      • uri.pl -- Process URIs
      • url.pl -- Analysing and constructing URL
      • www_browser.pl -- Open a URL in the users browser
      • prolog_colour.pl -- Prolog syntax colouring support.
      • record.pl -- Access compound arguments by name
      • prolog_xref.pl -- Prolog cross-referencer data collection
      • occurs.pl -- Finding and counting sub-terms
      • ordsets.pl -- Ordered set manipulation
      • assoc.pl -- Binary associations
      • ugraphs.pl -- Graph manipulation library
      • readutil.pl -- Read utilities
      • xpath.pl -- Select nodes in an XML DOM
      • iostream.pl -- Utilities to deal with streams
      • atom.pl -- Operations on atoms
      • porter_stem.pl
      • solution_sequences.pl -- Modify solution sequences
      • prolog_pack.pl -- A package manager for Prolog
      • prolog_config.pl -- Provide configuration information
      • process.pl -- Create processes and redirect I/O
      • git.pl -- Run GIT commands
      • ctypes.pl -- Character code classification
      • time.pl -- Time and alarm library
      • utf8.pl -- UTF-8 encoding/decoding on lists of character codes.
      • base64.pl -- Base64 encoding and decoding
      • sha.pl -- SHA secure hashes
      • crypt.pl
      • persistency.pl -- Provide persistent dynamic predicates
      • memfile.pl
      • pure_input.pl -- Pure Input from files and streams
      • nb_set.pl -- Non-backtrackable sets
      • xsdp_types.pl -- XML-Schema primitive types
      • uuid.pl -- Universally Unique Identifier (UUID) Library
      • pcre.pl -- Perl compatible regular expression matching for SWI-Prolog
      • aggregate.pl -- Aggregation operators on backtrackable predicates
      • rdf_write.pl -- Write RDF/XML from a list of triples
      • rdf.pl -- RDF/XML parser
      • sgml_write.pl -- XML/SGML writer module
      • archive.pl -- Access several archive formats
      • csv.pl -- Process CSV (Comma-Separated Values) data
      • dialect.pl -- Support multiple Prolog dialects
      • ssl.pl -- Secure Socket Layer (SSL) library
      • crypto.pl -- Cryptography and authentication library
      • apply_macros.pl -- Goal expansion rules to avoid meta-calling
      • pengines.pl -- Pengines: Web Logic Programming Made Easy
      • yall.pl -- Lambda expressions
      • prolog_code.pl -- Utilities for reasoning about code
      • sandbox.pl -- Sandboxed Prolog code
      • prolog_format.pl -- Analyse format specifications
      • zlib.pl -- Zlib wrapper for SWI-Prolog
      • thread.pl -- High level thread primitives
      • prolog_stack.pl -- Examine the Prolog stack
      • prolog_clause.pl -- Get detailed source-information about a clause
      • rbtrees.pl -- Red black trees
      • dif.pl -- The dif/2 constraint
      • modules.pl -- Module utility predicates
      • listing.pl -- List programs and pretty print clauses
      • system.pl -- System utilities
      • quintus.pl -- Quintus compatibility
      • ansi_term.pl -- Print decorated text to ANSI consoles
      • statistics.pl -- Get information about resource usage
      • terms.pl -- Term manipulation
      • tty.pl -- Terminal operations
      • backcomp.pl -- Backward compatibility
      • redis.pl -- Redis client
      • c14n2.pl -- C14n2 canonical XML documents
      • date.pl -- Process dates and times
      • double_metaphone.pl -- Phonetic string matching
      • snowball.pl -- The Snowball multi-lingual stemmer library
      • unix.pl -- Unix specific operations
      • lazy_lists.pl -- Lazy list handling
      • pengines_io.pl -- Provide Prolog I/O for HTML clients
      • prolog_stream.pl -- A stream with Prolog callbacks
      • random.pl -- Random numbers
      • term_to_json.pl
      • charsio.pl -- I/O on Lists of Character Codes
      • optparse.pl -- command line parsing
      • syslog.pl -- Unix syslog interface
      • uid.pl -- User and group management on Unix systems
      • edinburgh.pl -- Some traditional Edinburgh predicates
      • prolog_debug.pl -- User level debugging tools
      • rdf_triple.pl -- Create triples from intermediate representation
      • intercept.pl -- Intercept and signal interface
      • make.pl -- Reload modified source files
      • rdf_parser.pl
      • rewrite_term.pl
      • md5.pl -- MD5 hashes
      • help.pl -- Text based manual
      • files.pl
      • doc_latex.pl -- PlDoc LaTeX backend
      • edit.pl -- Editor interface
      • sort.pl
      • wfs.pl -- Well Founded Semantics interface
      • hashtable.pl -- Hash tables
      • prolog_codewalk.pl -- Prolog code walker
      • prolog_metainference.pl -- Infer meta-predicate properties
      • prolog_autoload.pl -- Autoload all dependencies
      • check.pl -- Consistency checking
      • hash_stream.pl -- Maintain a hash on a stream
      • udp_broadcast.pl -- A UDP broadcast proxy
      • editline.pl -- BSD libedit based command line editing
      • streampool.pl -- Input multiplexing
      • table.pl
      • protobufs.pl -- Google's Protocol Buffers ("protobufs")
      • janus.pl -- Call Python from Prolog
      • redis_streams.pl -- Using Redis streams
      • paxos.pl -- A Replicated Data Store
      • plunit.pl -- Unit Testing
      • readline.pl -- GNU readline interface
      • qsave.pl -- Save current program as a state or executable
      • zip.pl -- Access resource ZIP archives
      • stomp.pl -- STOMP client.
        • stomp_connection/5
        • stomp_connection/6
        • stomp_connection_property/2
        • stomp_destroy_connection/1
        • stomp_setup/2
        • stomp_teardown/1
        • stomp_reconnect/1
        • stomp_connect/1
        • stomp_connect/2
        • stomp_send/4
        • stomp_send_json/4
        • stomp_subscribe/4
        • stomp_unsubscribe/2
        • stomp_ack/3
        • stomp_nack/3
        • stomp_ack/2
        • stomp_nack/2
        • stomp_begin/2
        • stomp_commit/2
        • stomp_abort/2
        • stomp_transaction/2
        • stomp_disconnect/2
      • cgi.pl -- Read CGI parameters
      • main.pl -- Provide entry point for scripts
      • unicode.pl -- Unicode string handling
      • oset.pl -- Ordered set manipulation
      • threadutil.pl -- Interactive thread utilities
      • prolog_profile.pl -- Execution profiler
      • test_cover.pl -- Clause coverage analysis
      • prolog_breakpoints.pl -- Manage Prolog break-points
      • mqi.pl
      • isub.pl -- isub: a string similarity measure
      • when.pl -- Conditional coroutining
      • portray_text.pl -- Portray text
      • increval.pl -- Incremental dynamic predicate modification
      • tables.pl -- XSB interface to tables
      • rlimit.pl
      • writef.pl -- Old-style formatted write
      • prolog_jiti.pl -- Just In Time Indexing (JITI) utilities
      • explain.pl -- Describe Prolog Terms
      • prolog_trace.pl -- Print access to predicates
      • chr.pl
      • pwp.pl -- Prolog Well-formed Pages
      • heaps.pl -- heaps/priority queues
      • macros.pl -- Macro expansion
      • yaml.pl -- Process YAML data
      • dicts.pl -- Dict utilities
      • prolog_wrap.pl -- Wrapping predicates
      • varnumbers.pl -- Utilities for numbered terms
      • fastrw.pl -- Fast reading and writing of terms
      • xmlenc.pl -- XML encryption library
      • rwlocks.pl -- Read/write locks
      • doc_files.pl -- Create stand-alone documentation files
      • xmldsig.pl -- XML Digital signature
      • strings.pl -- String utilities
      • shell.pl -- Elementary shell commands
      • streams.pl -- Manage Prolog streams
      • codesio.pl -- I/O on Lists of Character Codes
      • prolog_history.pl -- Per-directory persistent commandline history
      • base32.pl -- Base32 encoding and decoding
 stomp_connection(+Address, +Host, +Headers, :Callback, -Connection) is det
 stomp_connection(+Address, +Host, +Headers, :Callback, -Connection, +Options) is det
Create a connection reference. The connection is not set up yet by this predicate. Callback is called on any received frame except for heart beat frames as below.
call(Callback, Command, Connection, Header, Body)

Where command is one of the commands below. Header is a dict holding the STOMP frame header, where all values are strings except for the 'content-length' key value which is passed as an integer.

Body is a string or, if the data is of the type application/json, a dict.

connected
A connection was established. Connection and Header are valid.
disconnected
The connection was lost. Only Connection is valid.
message
A message arrived. All three arguments are valid. Body is a dict if the content-type of the message is application/json and a string otherwise.
heartbeat
A heartbeat was received. Only Connection is valid. This callback is also called for each newline that follows a frame. These newlines can be a heartbeat, but can also be additional newlines that follow a frame.
heartbeat_timeout
No heartbeat was received. Only Connection is valid.
error
An error happened. All three arguments are valid and handled as message.

Note that stomp_teardown/1 causes the receiving and heartbeat thread to be signalled with abort/0.

Options processed:

reconnect(+Bool)
Try to reestablish the connection to the server if the connection is lost. Default is false
connect_timeout(+Seconds)
Maximum time to try and reestablish a connection. The default is 600 (10 minutes).
json_options(+Options)
Options passed to json_read_dict/3 to translate application/json content to Prolog. Default is [].
Arguments:
Address- is a valid address for tcp_connect/3. Normally a term Host:Port, e.g., localhost:32772.
Host- is a path denoting the STOMP host. Often just /.
Headers- is a dict with STOMP headers used for the CONNECT request.
Connection- is an opaque ground term that identifies the connection.
ClioPatria (version V3.1.1-48-gf653ce4)