Previous Next  

Element: SamplingPort

Document type

PartitionDescription

Document XPath

/PartitionDescription/Ports/SamplingPort

Schema XPath

/ConfigRecord/Module/Partitions/Partition/PartitionDescription/Ports/SamplingPort

Description

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>
			
Use

Required

Children

None

Attributes

Attribute

Direction

DriverName

MessageSize

Name

RefreshRate

Restrictions

None

Attribute: Attribute

Document XPath
/PartitionDescription/Ports/SamplingPort/@Attribute
Schema XPath
/ConfigRecord/Module/Partitions/Partition/PartitionDescription/Ports/SamplingPort/@Attribute
Description

The attribute is used to specify the port type.

Use

Optional

Target location

None

XML data type

PortAttributeType

Destination data type

N/A

Behavior if not specified

N/A

Values with special meanings

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.

Restrictions

Attribute: Direction

Document XPath
/PartitionDescription/Ports/SamplingPort/@Direction
Schema XPath
/ConfigRecord/Module/Partitions/Partition/PartitionDescription/Ports/SamplingPort/@Direction
Description

Whether the port is the source or destination of data.

Use

Required

Target location

ConfigRecord

XML data type

PortDirectionType

Destination data type

Unsigned 32 bit integer

Behavior if not specified

N/A

Values with special meanings

None

Restrictions

None

Attribute: DriverName

Document XPath
/PartitionDescription/Ports/SamplingPort/@DriverName
Schema XPath
/ConfigRecord/Module/Partitions/Partition/PartitionDescription/Ports/SamplingPort/@DriverName
Description

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.

Use

Optional

Target location

None

XML data type

DriverNameType

Destination data type

String

Behavior if not specified

N/A

Values with special meanings

None

Restrictions

None

Attribute: MessageSize

Document XPath
/PartitionDescription/Ports/SamplingPort/@MessageSize
Schema XPath
/ConfigRecord/Module/Partitions/Partition/PartitionDescription/Ports/SamplingPort/@MessageSize
Description

The maximum number of bytes in a user message for the port. All bytes are available for the user message.

Use

Required

Target location

ConfigRecord

XML data type

DecOrHexValueType

Destination data type

Unsigned 32 bit integer

Behavior if not specified

N/A

Values with special meanings

None

Restrictions

Attribute: Name

Document XPath
/PartitionDescription/Ports/SamplingPort/@Name
Schema XPath
/ConfigRecord/Module/Partitions/Partition/PartitionDescription/Ports/SamplingPort/@Name
Description

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.

Use

Required

Target location

ConfigRecord

XML data type

PortNameType

Destination data type

String

Behavior if not specified

N/A

Values with special meanings

None

Restrictions

Attribute: RefreshRate

Document XPath
/PartitionDescription/Ports/SamplingPort/@RefreshRate
Schema XPath
/ConfigRecord/Module/Partitions/Partition/PartitionDescription/Ports/SamplingPort/@RefreshRate
Description

The elapsed time after which the message available on the port is marked as stale, in seconds.

Use

Required

Target location

ConfigRecord

XML data type

DurationType

Destination data type

Unsigned 32 bit integer

Behavior if not specified

N/A

Values with special meanings

INFINITE_TIME: The message is never marked as stale.

Restrictions



Generated on 2007-10-15 17:17:22.