2.2.4.40 StreamType

  • Article

The StreamType Complex Type describes a block of base64-encoded stream data sent or received via the Remote Shell Protocol. For a command to execute, one or many of such blocks can be sent or received. Depending on the command, the Shell processor can receive and/or return ANSI data, Unicode data, or encodings specific to the command being executed. If ANSI data is used, then the client MUST specify WINRS_CODEPAGE as an option while creating the shell, as indicated in section 3.1.4.5.2. This option specifies the codepage to be used for ANSI data.

 <xs:complexType name="StreamType">
   <xs:simpleContent>
     <xs:extension
       base="xs:base64binary"
     >
       <xs:attribute name="Name"
         type="StreamName"
         use="required"
        />
       <xs:attribute name="CommandId"
         type="xs:anyURI"
         use="optional"
        />
       <xs:attribute name="End"
         type="xs:boolean"
         use="optional"
        />
       <xs:attribute name="Unit"
         type="xs:anyURI"
         use="optional"
        />
       <xs:attribute name="EndUnit"
         type="xs:boolean"
         use="optional"
        />
     </xs:extension>
   </xs:simpleContent>
 </xs:complexType>
 

Attributes

Name: A required attribute that MUST contain the name of the stream.

CommandId: This optional attribute indicates that the stream relates to a currently executing command and, if present, MUST be the one returned in the CommandResponse message. If absent, the stream relates directly to the Shell processor, not to the command in progress.

End: This optional attribute MUST be set to "true" to indicate that the stream is ending and that no more content will occur for this stream for the currently executing command. It MUST not be used for streams tied to the shell processor itself.

Unit: This optional attribute indicates the beginning of the logical record. This attribute can appear alone on the Stream element or can appear in combination with encoded data. If it appears alone, it indicates that the unit of transmission identified by the URI value is about to begin. Any subsequent data within the same stream is considered to be part of the unit, and the attribute need not reappear.

EndUnit: This optional attribute indicates the end of previously mentioned unit attribute. It is especially useful in case of nested unit.