![]() |
![]() |
![]() |
> PartitionDescription > Ports |
PartitionDescription
/ConfigRecord/Module/Partitions/Partition/PartitionDescription/Ports/SamplingPort
The SamplingPort element defines the configuration of sampling ports for a partition. A port in a partition must be configured as a partition direct-access port. A port in a partition can only connect to an application port in the application that resides in the same partition.
<PartitionDescription> ... <Ports> ... <SamplingPort Attribute="DIRECT_ACCESS_PORT" Name="my-sampling-port" Direction="SOURCE" MessageSize="100" RefreshRate="3600"/> </Ports> </PartitionDescription>
Required
None
None
The attribute is used to specify the port type.
Optional
None
N/A
N/A
DIRECT_ACCESS_PORT: The port is a partition direct-access port.
LOCAL_PORT: Not supported for partitions.
NULL_PORT: The port is a null port. A null source port sends no data. A null destination port accepts and consumes all data sent to it. Null ports are useful during development when not all applications or data sources are available.
PSEUDO_PORT: Not supported for partitions.
For a partition, this attribute must be set to either DIRECT_ACCESS_PORT or NULL_PORT. In a deployed system, this value should always be DIRECT_ACCESS_PORT.
Whether the port is the source or destination of data.
Required
ConfigRecord
Unsigned 32 bit integer
N/A
None
None
The name of the port driver used by the port. This must be a user-mode port driver residing in the partition OS. This value must match the name of the driver passed to the portPseudoDrvAdd() in the partition OS.
Optional
None
String
N/A
None
None
The maximum number of bytes in a user message for the port. All bytes are available for the user message.
Required
ConfigRecord
Unsigned 32 bit integer
N/A
None
The maximum value is 0x100000.
The name of the port. This value is used to assign a port to a channel in the Module configuration document using /Module/Connections/Channel/Source/@PortNameRef and /Module/Connections/Channel/Destination/@PortNameRef.
Required
ConfigRecord
String
N/A
None
The name of the port must be unique within the partition. Port names are treated as case insensitive values.
The port name must not be empty and must not exceed 30 characters.
The elapsed time after which the message available on the port is marked as stale, in seconds.
Required
ConfigRecord
Unsigned 32 bit integer
N/A
INFINITE_TIME: The message is never marked as stale.
The build tools multiply the specified value by 1,000,000,000 to give a value in nanoseconds. The maximum value is therefore 18446744073.709551614 and the minimum increment is 0.000000001.
Generated on 2007-10-15 17:17:22.