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

/home/swipl/lib/swipl/library/pengines.pl
AllApplicationManualNameSummaryHelp

  • swipl
    • library
      • error.pl
      • apply.pl
      • lists.pl
      • 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 -- Utility library for loading foreign objects (DLLs, shared objects)
      • option.pl
      • uid.pl -- User and group management on Unix systems
      • unix.pl
      • 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
      • crypto.pl
      • filesex.pl -- Extended operations on files
      • doc_http.pl -- Documentation server
      • pldoc.pl -- Process source documentation
      • operators.pl -- Manage operators
      • pairs.pl -- Operations on key-value lists
      • prolog_source.pl -- Examine Prolog source-files
      • 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
      • memfile.pl
      • 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
      • 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
      • apply_macros.pl -- Goal expansion rules to avoid meta-calling
      • prolog_code.pl -- Utilities for reasoning about code
      • dif.pl -- The dif/2 constraint
      • thread.pl -- High level thread primitives
      • rdf_triple.pl -- Create triples from intermediate representation
      • rdf_parser.pl
      • rewrite_term.pl
      • rbtrees.pl -- Red black trees
      • nb_rbtrees.pl -- Non-backtrackable operations on red black trees
      • pengines.pl -- Pengines: Web Logic Programming Made Easy
        • pengine_create/1
        • pengine_ask/3
        • pengine_next/2
        • pengine_stop/2
        • pengine_abort/1
        • pengine_destroy/1
        • pengine_destroy/2
        • pengine_self/1
        • pengine_application/1
        • current_pengine_application/1
        • pengine_property/2
        • pengine_output/1
        • pengine_debug/2
        • pengine_done/0
        • prepare_module/3
        • prepare_goal/3
        • not_sandboxed/2
        • pengine_pull_response/2
        • pengine_input/2
        • pengine_respond/3
        • pengine_event_loop/2
        • pengine_rpc/2
        • pengine_rpc/3
        • prompt/3
        • output/2
        • portray_blob/2
        • write_result/3
        • add_error_details/3
        • event_to_json/3
        • authentication_hook/3
        • pengine_user/1
        • create_pool/1
      • yall.pl -- Lambda expressions
      • sandbox.pl -- Sandboxed Prolog code
      • prolog_format.pl -- Analyse format specifications
      • random.pl -- Random numbers
      • pengines_io.pl -- Provide Prolog I/O for HTML clients
      • 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
      • pprint.pl -- Pretty Print Prolog terms
      • modules.pl -- Module utility predicates
      • lazy_lists.pl -- Lazy list handling
      • edinburgh.pl -- Some traditional Edinburgh predicates
      • prolog_clause.pl -- Get detailed source-information about a clause
      • prolog_breakpoints.pl -- Manage Prolog break-points
      • dicts.pl -- Dict utilities
      • redis.pl -- Redis client
      • prolog_profile.pl -- Execution profiler
      • check.pl -- Consistency checking
      • system.pl -- System utilities
      • quintus.pl -- Quintus compatibility
      • terms.pl -- Term manipulation
      • charsio.pl -- I/O on Lists of Character Codes
      • backcomp.pl -- Backward compatibility
      • qsave.pl -- Save current program as a state or executable
      • zip.pl -- Access resource ZIP archives
      • tty.pl -- Terminal operations
      • jpl.pl -- A Java interface for SWI Prolog 7.x
      • prolog_debug.pl -- User level debugging tools
      • term_to_json.pl
      • protobufs.pl -- Google's Protocol Buffers ("protobufs")
      • threadutil.pl -- Interactive thread utilities
      • statistics.pl -- Get information about resource usage
      • editline.pl -- BSD libedit based command line editing
      • prolog_stack.pl -- Examine the Prolog stack
      • sort.pl
      • explain.pl -- Describe Prolog Terms
      • odbc.pl
      • doc_latex.pl -- PlDoc LaTeX backend
      • plunit.pl -- Unit Testing
      • streams.pl -- Manage Prolog streams
      • ansi_term.pl -- Print decorated text to ANSI consoles
      • writef.pl -- Old-style formatted write
      • date.pl -- Process dates and times
      • shell.pl -- Elementary shell commands
      • xmldsig.pl -- XML Digital signature
      • c14n2.pl -- C14n2 canonical XML documents
      • xmlenc.pl -- XML encryption library
      • listing.pl -- List programs and pretty print clauses
      • snowball.pl -- The Snowball multi-lingual stemmer library
      • unicode.pl -- Unicode string handling
      • stomp.pl -- STOMP client.
      • prolog_autoload.pl -- Autoload all dependencies
      • wfs.pl -- Well Founded Semantics interface
      • test_cover.pl -- Clause coverage analysis
      • base32.pl -- Base32 encoding and decoding
      • codesio.pl -- I/O on Lists of Character Codes
      • coinduction.pl -- Co-Logic Programming
      • heaps.pl -- heaps/priority queues
      • varnumbers.pl -- Utilities for numbered terms
      • when.pl -- Conditional coroutining
      • prolog_codewalk.pl -- Prolog code walker
      • paxos.pl -- A Replicated Data Store
      • edit.pl -- Editor interface
      • optparse.pl -- command line parsing
      • intercept.pl -- Intercept and signal interface
      • readline.pl -- GNU readline interface
      • redis_streams.pl -- Using Redis streams
      • increval.pl -- Incremental dynamic predicate modification
      • tables.pl -- XSB interface to tables
      • prolog_metainference.pl -- Infer meta-predicate properties
      • double_metaphone.pl -- Phonetic string matching
      • oset.pl -- Ordered set manipulation
      • udp_broadcast.pl -- A UDP broadcast proxy
      • table.pl
      • yaml.pl -- Process YAML data
      • isub.pl -- isub: a string similarity measure
      • pwp.pl -- Prolog Well-formed Pages
      • pdt_console.pl
      • help.pl -- Text based manual
      • doc_files.pl -- Create stand-alone documentation files
      • prolog_stream.pl -- A stream with Prolog callbacks
      • prolog_jiti.pl -- Just In Time Indexing (JITI) utilities
      • portray_text.pl -- Portray text
      • mqi.pl
      • make.pl -- Reload modified source files
      • strings.pl -- String utilities
      • files.pl
      • cgi.pl -- Read CGI parameters
      • streampool.pl -- Input multiplexing
      • fastrw.pl -- Fast reading and writing of terms
      • hashtable.pl -- Hash tables
      • prolog_trace.pl -- Print access to predicates
      • prolog_history.pl -- Per-directory persistent commandline history
      • win_menu.pl -- Console window menu
      • rlimit.pl
      • prolog_wrap.pl -- Wrapping predicates
 pengine_ask(+NameOrID, @Query, +Options) is det
Asks pengine NameOrID a query Query.

Options is a list of options:

template(+Template)
Template is a variable (or a term containing variables) shared with the query. By default, the template is identical to the query.
chunk(+Integer)
Retrieve solutions in chunks of Integer rather than one by one. 1 means no chunking (default). Other integers indicate the maximum number of solutions to retrieve in one chunk.
bindings(+Bindings)
Sets the global variable '$variable_names' to a list of Name = Var terms, providing access to the actual variable names.

Any remaining options are passed to pengine_send/3.

Note that the predicate pengine_ask/3 is deterministic, even for queries that have more than one solution. Also, the variables in Query will not be bound. Instead, results will be returned in the form of event terms.

success(ID, Terms, Projection, Time, More)
ID is the id of the pengine that succeeded in solving the query. Terms is a list holding instantiations of Template. Projection is a list of variable names that should be displayed. Time is the CPU time used to produce the results and finally, More is either true or false, indicating whether we can expect the pengine to be able to return more solutions or not, would we call pengine_next/2.
failure(ID)
ID is the id of the pengine that failed for lack of a solutions.
error(ID, Term)
ID is the id of the pengine throwing the exception. Term is the exception's error term.
output(ID, Term)
ID is the id of a pengine running the query that called pengine_output/1. Term is the term that was passed in the first argument of pengine_output/1 when it was called.
prompt(ID, Term)
ID is the id of the pengine that called pengine_input/2 and Term is the prompt.

Defined in terms of pengine_send/3, like so:

pengine_ask(ID, Query, Options) :-
    partition(pengine_ask_option, Options, AskOptions, SendOptions),
    pengine_send(ID, ask(Query, AskOptions), SendOptions).
ClioPatria (version V3.1.1-42-gd6a756b-DIRTY)