From ba55a108cd393e80c6e786e46b9b0b5d02745d3f Mon Sep 17 00:00:00 2001 From: "Alan T. DeKok" Date: Fri, 24 Sep 2021 10:17:56 -0400 Subject: [PATCH] update interpreter docs --- doc/antora/modules/reference/nav.adoc | 2 ++ doc/antora/modules/reference/pages/unlang/index.adoc | 12 ++++++++++++ 2 files changed, 14 insertions(+) diff --git a/doc/antora/modules/reference/nav.adoc b/doc/antora/modules/reference/nav.adoc index 3aa5b30032..0f66a474af 100644 --- a/doc/antora/modules/reference/nav.adoc +++ b/doc/antora/modules/reference/nav.adoc @@ -24,6 +24,8 @@ **** xref:unlang/switch.adoc[switch] **** xref:unlang/update.adoc[update] +*** xref:unlang/interpreter.adoc[Interpreter] + *** xref:unlang/module.adoc[Modules] **** xref:unlang/module_method.adoc[Module Methods] **** xref:unlang/module_builtin.adoc[Built-in Modules] diff --git a/doc/antora/modules/reference/pages/unlang/index.adoc b/doc/antora/modules/reference/pages/unlang/index.adoc index 887dbc5bcf..4e21d1ca81 100644 --- a/doc/antora/modules/reference/pages/unlang/index.adoc +++ b/doc/antora/modules/reference/pages/unlang/index.adoc @@ -41,6 +41,18 @@ load-balance { } ---- +== Interpreter + +The xref:unlang/interpreter.adoc[Interpreter] processes an input +"request" packet, by running policies which contain +xref:unlang/keywords.adoc[Keywords]. The result of the interpretation +is usually an output "reply" packet. + +While the interpreter allows some fairly complex policies to be made, +it is not a general purpose programming language. The purpose of the +language is to receive packets, process their contents, and send +replies. A secondary goal is to do that as quickly as possible. + == Conditional Expressions xref:condition/index.adoc[Conditional expressions], which are used to check -- 2.47.2