- Parameters:
Parameter | Description | Default |
id | Process ID | none, required parameter |
name | A text description of this locale | value of id |
url | Specify a URL to be used when clicking on this particular locale in data flow diagrams | Wiki page where this data flow diagram is found |
deprecated | Indicates whether this locale is still in use and how and when it will be rendered | 0 |
connect | Connections via transports to other locales | none |
Locales are rendered in diagrams as Graphviz cluster subgraphs. The subgraph will be labeled using
name. The
connect parameter is used to determine whether non-multicast data can flow between two locales.
The format of the
connect parameter is a comma-separated list of pairs of
locale|transport
. As an example:
%DFDLOCALE{id="here" name="My Place" connect="there|ICMP"}%
%DFDLOCALE{id="there" name="Your Place"}%
In the above example, data utilizing the
ICMP
transport can flow from
here
to
there
, but not from
there
to
here
.
Note: There are no defaults for connections
even for the self-locale. This means that in the above example, data utilizing the
ICMP
transport cannot be sent from
here
to
here
successfully. To remedy that, define your locale in the following fashion:
%DFDLOCALE{id="elsewhere" name="Another Place" connect="elsewhere|ICMP, there|ICMP, here|ICMP"}%
The above example allows the
elsewhere
locale to send data via
ICMP
to itself,
here
and
there
.