complexType "connectionType"
Namespace:
Content:
complex, 3 attributes, 6 elements
Defined:
globally in myalerts.xsd; see XML source
Includes:
definitions of 6 elements
Used:
XML Representation Summary
<...
   
 = 
xsd:nonNegativeInteger
 = 
xsd:hexBinary
 = 
xsd:string
   
>
   
Content: 
</...>
Content Model Elements (6):
argot (type argotType), argotQuery (type notificationQueryType), characteristics (in connection), class (in connection), expiration (type xsd:string), status (in connection)
All Direct / Indirect Based Elements (1):
connection (in myAlerts)
Known Usage Locations
Annotation
Abbreviations: CXN (Connection): The vonnection exists inside of the .NET Alerts service. UA (UserAgent): The userAgent exists outside of the .NET Alerts service. There are two primary types of connections: Push: Alerts are pushed by CXN to UA. Pull: Alerts are downloaded by the UA by issuing a request to CXN. The response contains the alerts. A CXN is created (added to the .NET Alerts content document) either by the UA directly or by some entity acting on behalf of the UA. In order to transfer the alerts, a session, either persistent or transient, is established between CXN and UA. In cases in which sessions are transient, the CXN persists. Establishment of a session can be initiated by either CXN or UA, either when the CXN is created or based on, say, a timer or some signaling mechanism between CXN and UA. The session can be closed by either entity after a period of time (including 0). The following are different models of UA-CXN interaction: 1) UA establishes a session with a CXN and pulls alerts from CXN. 2) UA establishes a session with a CXN and the CXN pushes alerts to the UA. 3) CXN establishes a session with a UA and the UA pulls alerts. 4) CXN establishes a session with a UA and pushes alerts to UA. 5) UA polls the CXN periodically on a timer and UA will initiate process #1 or #2. 6) CXN polls the UA when alerts arrive or periodically on a timer. When there are pending alerts in the queue, UA will initiate process #1 or #2.
XML Source (see within schema source)
<xsd:complexType name="connectionType">
<xsd:annotation>
<xsd:documentation>
Abbreviations:
CXN (Connection): The vonnection exists inside of
the .NET Alerts service.

UA (UserAgent): The userAgent exists outside of
the .NET Alerts service.

There are two primary types of connections:

Push: Alerts are pushed by CXN to UA.
Pull: Alerts are downloaded by the UA
by issuing a request to CXN. The response
contains the alerts.

A CXN is created (added to the .NET Alerts
content document) either by the UA directly or by some entity acting on behalf of the UA.

In order to transfer the alerts, a session, either persistent or transient, is established
between CXN and UA. In cases in which sessions are transient, the CXN persists.
Establishment of a session can be initiated by either CXN or UA,
either when the CXN is created or based on, say, a timer or some
signaling mechanism between CXN and UA. The session can be closed by either entity
after a period of time (including 0).

The following are different models of UA-CXN
interaction:

1) UA establishes a session with a CXN and pulls alerts
from CXN.
2) UA establishes a session with a CXN and the CXN pushes
alerts to the UA.
3) CXN establishes a session with a UA and the UA pulls
alerts.
4) CXN establishes a session with a UA and pushes alerts
to UA.
5) UA polls the CXN periodically on a timer and UA will initiate
process #1 or #2.
6) CXN polls the UA when alerts arrive or periodically on a
timer. When there are pending alerts in the queue, UA will
initiate process #1 or #2.
</xsd:documentation>
</xsd:annotation>
<xsd:sequence>
<xsd:element maxOccurs="1" minOccurs="1" name="class" type="connectionClassType">
<!-- sgfix: illegal on an element
use="required"
-->
<xsd:annotation>
<xsd:documentation>
This element specifies the class of a connection (for example, Push over
Soap-RP or Pull over Soap-RP).
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element maxOccurs="1" minOccurs="1" name="status" type="connectionStatusType">
<xsd:annotation>
<xsd:documentation>
Flags indicating the current status of the connection. Can be used by the Stream modules
to do traffic management, buffering, generate nondelivery and delayed delivery
reports for the sender.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element maxOccurs="1" minOccurs="1" name="characteristics" type="connectionCharacteristicsType">
<xsd:annotation>
<xsd:documentation>
Information about the nature of the connection, used mainly
by the Stream modules. Reliable can mean it supports ACKs;
unreliable means it is fire-and-forget. Type of polling used
(Connection vs. UserAgent).
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element maxOccurs="1" minOccurs="1" name="expiration" type="xsd:string">
<xsd:annotation>
<xsd:documentation>
Lifetime of a connection in absolute time (GMT).
This can be used to clean up the content document.
BUGBUG - we really should use a date type not string for
the type attribute!
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element maxOccurs="1" minOccurs="1" name="argotQuery" type="notificationQueryType">
<xsd:annotation>
<xsd:documentation>
The connection's query against incoming alerts.
The query specifies the argot name(s) that enable selection (a logical OR of the named argots).
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element maxOccurs="unbounded" minOccurs="0" name="argot" type="argotType">
<xsd:annotation>
<xsd:documentation>
An optional provisioning argot for the connection.
This is dependent on the connection class. For more information, see the available connection classes.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
<xsd:attributeGroup ref="hs:standardBlueAttributeGroup"/>
</xsd:complexType>
Attribute Detail (all declarations; 3/3)
changeNumber
Type:
Use:
required
Defined:
XML Source (see within schema source)
<xsd:attribute name="changeNumber" type="changeNumberType" use="required"/>

creator
Type:
Use:
required
Defined:
XML Source (see within schema source)
<xsd:attribute name="creator" type="creatorType" use="required"/>

id
Type:
Use:
required
Defined:
XML Source (see within schema source)
<xsd:attribute name="id" type="idType" use="required"/>
Content Element Detail (all declarations; 6/6)
argot
Type:
argotType, complex content
Defined:
locally within (this) connectionType complexType
An optional provisioning argot for the connection. This is dependent on the connection class. For more information, see the available connection classes.
XML Source (see within schema source)
<xsd:element maxOccurs="unbounded" minOccurs="0" name="argot" type="argotType">
<xsd:annotation>
<xsd:documentation>
An optional provisioning argot for the connection.
This is dependent on the connection class. For more information, see the available connection classes.
</xsd:documentation>
</xsd:annotation>
</xsd:element>

argotQuery
Type:
notificationQueryType, simple content
Defined:
locally within (this) connectionType complexType
The connection's query against incoming alerts. The query specifies the argot name(s) that enable selection (a logical OR of the named argots).
XML Source (see within schema source)
<xsd:element maxOccurs="1" minOccurs="1" name="argotQuery" type="notificationQueryType">
<xsd:annotation>
<xsd:documentation>
The connection's query against incoming alerts.
The query specifies the argot name(s) that enable selection (a logical OR of the named argots).
</xsd:documentation>
</xsd:annotation>
</xsd:element>

characteristics
Type:
Defined:
locally within (this) connectionType complexType
Information about the nature of the connection, used mainly by the Stream modules. Reliable can mean it supports ACKs; unreliable means it is fire-and-forget. Type of polling used (Connection vs. UserAgent).
XML Source (see within schema source)
<xsd:element maxOccurs="1" minOccurs="1" name="characteristics" type="connectionCharacteristicsType">
<xsd:annotation>
<xsd:documentation>
Information about the nature of the connection, used mainly
by the Stream modules. Reliable can mean it supports ACKs;
unreliable means it is fire-and-forget. Type of polling used
(Connection vs. UserAgent).
</xsd:documentation>
</xsd:annotation>
</xsd:element>

class
Type:
connectionClassType, simple content
Defined:
locally within (this) connectionType complexType
This element specifies the class of a connection (for example, Push over Soap-RP or Pull over Soap-RP).
XML Source (see within schema source)
<xsd:element maxOccurs="1" minOccurs="1" name="class" type="connectionClassType">
<!-- sgfix: illegal on an element
use="required"
-->
<xsd:annotation>
<xsd:documentation>
This element specifies the class of a connection (for example, Push over
Soap-RP or Pull over Soap-RP).
</xsd:documentation>
</xsd:annotation>
</xsd:element>

expiration
Type:
xsd:string, predefined, simple content
Defined:
locally within (this) connectionType complexType
Lifetime of a connection in absolute time (GMT). This can be used to clean up the content document. BUGBUG - we really should use a date type not string for the type attribute!
XML Source (see within schema source)
<xsd:element maxOccurs="1" minOccurs="1" name="expiration" type="xsd:string">
<xsd:annotation>
<xsd:documentation>
Lifetime of a connection in absolute time (GMT).
This can be used to clean up the content document.
BUGBUG - we really should use a date type not string for
the type attribute!
</xsd:documentation>
</xsd:annotation>
</xsd:element>

status
Type:
connectionStatusType, simple content
Defined:
locally within (this) connectionType complexType
Flags indicating the current status of the connection. Can be used by the Stream modules to do traffic management, buffering, generate nondelivery and delayed delivery reports for the sender.
XML Source (see within schema source)
<xsd:element maxOccurs="1" minOccurs="1" name="status" type="connectionStatusType">
<xsd:annotation>
<xsd:documentation>
Flags indicating the current status of the connection. Can be used by the Stream modules
to do traffic management, buffering, generate nondelivery and delayed delivery
reports for the sender.
</xsd:documentation>
</xsd:annotation>
</xsd:element>