Skip to content

Commit a67add8

Browse files
committed
[core] Update configuration comments
1 parent 703a468 commit a67add8

1 file changed

Lines changed: 9 additions & 6 deletions

File tree

hacking/config.yaml

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -225,19 +225,22 @@ o2:
225225
begin: 0
226226
end: 3
227227
var: it
228-
# "connect" is the *outbound* channel equivalent of the "bind" specification
229-
# found in the tasks section. This is a list of outbound channels, with
230-
# the same meaning as the entries in "bind", the only difference being
231-
# the "target" value.
228+
# "connect" is the *outbound* channel equivalent of the "bind" specification found in the tasks section.
229+
# This is a list of outbound channels, with the same meaning as the entries in "bind", the only difference
230+
# being the "target" value.
231+
# Note that "inbound" and "outbound" here refers only to the initiation of the TCP connections. The data flow
232+
# direction is dictated by the "type" parameter.
232233
connect:
233234
- name: "data1"
234235
# The target entry is a string, with some template functions available for traversing the control tree.
235236
# Available functions:
236237
# parent() - returns the path of the parent role (example: {{parent}}.someRoleName to get a sibling role)
237238
# up(int n) - returns the path of the n-th ancestor (example: {{up 2}}.someRole.otherRole to get a cousin role)
238239
# this() - returns the path of the current role (example: {{this}}.someRole to get a child role)
239-
# Please note that these functions operate on the in-memory control tree and not on the workflow template
240-
# as it appears in the configuration file (or database).
240+
# Please note that these paths operate on the in-memory control tree and not on the workflow template
241+
# as it appears in the configuration file (or database): the control tree is traversed after the iterator
242+
# roles have already been resolved and expanded. Thus, one can never reference "processor{{.it}}", only
243+
# a specific "processor3".
241244
# By whatever means, the target must ultimately contain a valid complete path to a role, followed by a ":"
242245
# and the name of the inbound channel (as it appears in the bind spec of the task template).
243246
target: "{{ parent }}.sampler:data1"

0 commit comments

Comments
 (0)