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

  • swipl
    • library
      • error.pl
      • apply.pl -- Apply predicates on a list
      • lists.pl -- List Manipulation
      • debug.pl -- Print debug messages and test assertions
      • broadcast.pl
      • socket.pl -- Network socket (TCP and UDP) library
      • predicate_options.pl -- Access and analyse predicate options
      • shlib.pl
      • 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
      • 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
      • 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
      • strings.pl -- String utilities
      • dif.pl -- The dif/2 constraint
      • dialect.pl -- Support multiple Prolog dialects
      • 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
      • persistency.pl -- Provide persistent dynamic predicates
      • pengines_sandbox.pl -- Declare Pengine interaction sandbox-safe
      • term_to_json.pl
      • 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
      • rbtrees.pl -- Red black trees
      • nb_set.pl -- Non-backtrackable sets
      • prolog_stream.pl -- A stream with Prolog callbacks
      • backcomp.pl -- Backward compatibility
      • charsio.pl -- I/O on Lists of Character Codes
      • paxos.pl -- A Replicated Data Store
      • statistics.pl -- Get information about resource usage
      • tty.pl -- Terminal operations
      • increval.pl -- Incremental dynamic predicate modification
      • heaps.pl -- heaps/priority queues
      • stomp.pl -- STOMP client.
      • sgml_write.pl -- XML/SGML writer module
      • when.pl -- Conditional coroutining
      • base32.pl -- Base32 encoding and decoding
      • codesio.pl -- I/O on Lists of Character Codes
      • udp_broadcast.pl -- A UDP broadcast proxy
      • table.pl
      • coinduction.pl -- Co-Logic Programming
      • prolog_codewalk.pl -- Prolog code walker
      • date.pl -- Process dates and times
      • odbc.pl
      • macros.pl -- Macro expansion
      • crypt.pl
      • plunit.pl -- Unit Testing
      • xmldsig.pl -- XML Digital signature
      • isub.pl -- isub: a string similarity measure
      • snowball.pl -- The Snowball multi-lingual stemmer library
      • fastrw.pl -- Fast reading and writing of terms
      • tables.pl -- XSB interface to tables
      • writef.pl -- Old-style formatted write
      • help.pl -- Text based manual
      • check.pl -- Consistency checking
      • thread.pl -- High level thread primitives
      • archive.pl -- Access several archive formats
      • hashtable.pl -- Hash tables
      • editline.pl -- BSD libedit based command line editing
      • redis.pl -- Redis client
      • unicode.pl -- Unicode string handling
      • prolog_metainference.pl -- Infer meta-predicate properties
      • explain.pl -- Describe Prolog Terms
      • threadutil.pl -- Interactive thread utilities
      • quintus.pl -- Quintus compatibility
      • double_metaphone.pl -- Phonetic string matching
      • xsdp_types.pl -- XML-Schema primitive types
      • doc_files.pl -- Create stand-alone documentation files
      • prolog_debug.pl -- User level debugging tools
      • rewrite_term.pl
      • protobufs.pl -- Google's Protocol Buffers ("protobufs")
      • streampool.pl -- Input multiplexing
      • pwp.pl -- Prolog Well-formed Pages
      • prolog_jiti.pl -- Just In Time Indexing (JITI) utilities
      • yaml.pl -- Process YAML data
      • files.pl
      • test_cover.pl -- Clause coverage analysis
      • optparse.pl -- command line parsing
      • make.pl -- Reload modified source files
      • rwlocks.pl -- Read/write locks
      • rdf.pl -- RDF/XML parser
      • rdf_triple.pl -- Create triples from intermediate representation
      • rdf_parser.pl
      • prolog_trace.pl -- Print access to predicates
      • prolog_wrap.pl -- Wrapping predicates
      • portray_text.pl -- Portray text
      • qsave.pl -- Save current program as a state or executable
      • zip.pl -- Access resource ZIP archives
      • c14n2.pl -- C14n2 canonical XML documents
      • intercept.pl -- Intercept and signal interface
      • shell.pl -- Elementary shell commands
      • system.pl -- System utilities
      • prolog_versions.pl -- Demand specific Prolog versions
      • edit.pl -- Editor interface
      • xmlenc.pl -- XML encryption library
      • readline.pl -- GNU readline interface
      • prolog_profile.pl -- Execution profiler
      • rlimit.pl
      • redis_streams.pl -- Using Redis streams
      • utf8.pl -- UTF-8 encoding/decoding on lists of character codes.
      • cgi.pl -- Read CGI parameters
      • readln.pl -- Read line as list of tokens
      • prolog_autoload.pl -- Autoload all dependencies
      • mqi.pl
        • mqi_start/1
        • mqi_version/2
        • mqi_start/0
        • mqi_stop/1
      • doc_latex.pl -- PlDoc LaTeX backend
      • rdf_write.pl -- Write RDF/XML from a list of triples
      • prolog_history.pl -- Per-directory persistent commandline history
      • streams.pl -- Manage Prolog streams
      • oset.pl -- Ordered set manipulation
 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.