Skip to main content
Altcraft Docs LogoAltcraft Docs Logo
User guideDeveloper guideAdmin guide
Company siteHelp center
English
  • Русский
  • English
v72
  • v74
  • v73
  • v72
Login
  • Getting Started
  • Administrator documentation
  • Functional characteristics
  • Technology description
  • System requirements
  • Admin Panel
  • Platform installation
  • Platform configuration
  • Platform maintenance
  • Custom channels guide
    • Overview
    • Creating and configuring a channel
    • Entity field configuration
    • Template language
    • Entities
    • Pipes
      • Pipe: Basic Concepts
      • Result
      • Errors
      • Log
      • Pack
      • Unpack
      • HTTP Request
      • Store Set
      • Store Get
      • Selector
      • SQL
      • Eventer
      • Scheduler
    • Pipelines
  • Extra
  • Processing HTTP/HTTPS traffic
  • Administrator API
This is documentation for Altcraft Platform v72. This documentation is no longer maintained.
The information for up-to-date platform version at this page is available (v74).
  • Custom channels guide
  • Pipes
  • Pipe: Basic Concepts
Documentation for version v72

Pipe: Basic Concepts

Description​

Pipe is an element that performs one action. For example, the log pipe writes a log, and the http_request pipe executes an http request. A pipe has an entrance and may have several exits. Exits are not required. If the pipeline does not have them, then the event will exit the pipeline.

Each pipe in the pipeline is an array of workers, the number of which is configured in the configuration file in the PIPE_WORKER_SIZE parameter.

General structure​

| Field | Example | Required | Description | | ------ | ---------- | -------- | ------------------------- | ------ | --- | --- | ------------------------------ | | id | 5 | yes | Id of a pipe. It's output | | type | "log" | yes | A type of a pipe | | params | | no | | params | | no | Specific parameters for a type | | | | outs | OutsObject | no | Outputs of a pipe |

OutsObject
FieldExampleRequiredDescription
success3noOutput of a pipe if there is no mistake
error4noOutput of a pipe if there is a mistake

Template language​

Fields with this label support templating (blue star). The templating language is described in this article.

Last updated on Oct 31, 2024
Previous
Pipes
Next
Result
  • Description
  • General structure
  • Template language
© 2015 - 2025 Altcraft, LLC. All rights reserved.