/usr/lib/swipl/library/mqi.pl
AllApplicationManualNameSummaryHelp

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

Note that the initial version of the MQI did not have a version predicate so The proper way for callers to check the version is:

use_module(library(mqi)), ( current_predicate(mqi_version/2) -> mqi_version(Major_Version, Minor_Version) ; Major_Version = 0, Minor_Version = 0 )

Major versions are increased when there is a change to the protocol that will likely break clients written to the previous version. Minor versions are increased when there is new functionality that will not break clients written to the old version

This allows a client written to MQI version 'Client_Major_Version.Client_Minor_Version' to check for non-breaking compatibility like this:

Client_Major_Version = MQI_Major_Version and Client_Minor_Version <= MQI_Minor_Version

Breaking changes (i.e. Major version increments) should be very rare as the goal is to have the broadest adoption possible.

Protocol Version History:

  • 0.0 First published version. Had a protocol bug that required messages sent to MQI to count Unicode code points instead of bytes for the message header.
  • 1.0 Breaking change: Fixed protocol bug so that it properly accepted byte count instead of Unicode code point count in the message header for messages sent to MQI.