Previous Next  

Element: QueuingPort

Document type

ApplicationDescription

Document XPath

/ApplicationDescription/Ports/QueuingPort

Schema XPath

/ConfigRecord/Module/Applications/Application/ApplicationDescription/Ports/QueuingPort

Description

The QueuingPort element defines the configuration of queuing ports for an application.

<ApplicationDescription>
 ...
 <Ports>
  ...
  <QueuingPort
   MessageSize="1024"
   Name="input1"
   QueueLength="10"
   Protocol="RECEIVER_DISCARD"
   Direction="SOURCE"/>
 </Ports>
</ApplicationDescription>
		
Use

Required

Children

None

Attributes

Attribute

Direction

DriverName

MessageSize

Name

Protocol

QueueLength

RefreshRate

Restrictions

None

Attribute: Attribute

Document XPath
/ApplicationDescription/Ports/QueuingPort/@Attribute
Schema XPath
/ConfigRecord/Module/Applications/Application/ApplicationDescription/Ports/QueuingPort/@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: Not supported for applications.

LOCAL_PORT: The port is an ARINC port in the local application.

NULL_PORT: The port is a null port in the local application. 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 applications.

Restrictions

Attribute: Direction

Document XPath
/ApplicationDescription/Ports/QueuingPort/@Direction
Schema XPath
/ConfigRecord/Module/Applications/Application/ApplicationDescription/Ports/QueuingPort/@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
/ApplicationDescription/Ports/QueuingPort/@DriverName
Schema XPath
/ConfigRecord/Module/Applications/Application/ApplicationDescription/Ports/QueuingPort/@DriverName
Description

Not used for application ports. Support for local ports is provided by the ARINC ports components in the core 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
/ApplicationDescription/Ports/QueuingPort/@MessageSize
Schema XPath
/ConfigRecord/Module/Applications/Application/ApplicationDescription/Ports/QueuingPort/@MessageSize
Description

The maximum message size (in bytes) 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
/ApplicationDescription/Ports/QueuingPort/@Name
Schema XPath
/ConfigRecord/Module/Applications/Application/ApplicationDescription/Ports/QueuingPort/@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: Protocol

Document XPath
/ApplicationDescription/Ports/QueuingPort/@Protocol
Schema XPath
/ConfigRecord/Module/Applications/Application/ApplicationDescription/Ports/QueuingPort/@Protocol
Description

The protocol for the port.

Use

Required

Target location

ConfigRecord

XML data type

xs:string

Destination data type

Unsigned 32 bit integer

Behavior if not specified

N/A

Values with special meanings

NOT_APPLICABLE: The protocol is specified for a source port only, so if the port is a destination port, the protocol setting is NOT_APPLICABLE.

RECEIVER_DISCARD: The receiver discard protocol is used.

SENDER_BLOCK: The sender block protocol is used.

Restrictions

Attribute: QueueLength

Document XPath
/ApplicationDescription/Ports/QueuingPort/@QueueLength
Schema XPath
/ConfigRecord/Module/Applications/Application/ApplicationDescription/Ports/QueuingPort/@QueueLength
Description

The maximum number of messages that the port can handle at one time.

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: RefreshRate

Document XPath
/ApplicationDescription/Ports/QueuingPort/@RefreshRate
Schema XPath
/ConfigRecord/Module/Applications/Application/ApplicationDescription/Ports/QueuingPort/@RefreshRate
Description

This attribute is reserved for future use.

Use

Optional

Target location

None

XML data type

DurationType

Destination data type

Unsigned 32 bit integer

Behavior if not specified

N/A

Values with special meanings

None

Restrictions

None




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