ASN1C C# Runtime Library  7.8
Public Member Functions | Properties | List of all members
Asn1XerOutputStream Class Reference
Inheritance diagram for Asn1XerOutputStream:
Asn1OutputStream Asn1XerEncoder Asn1Writable Asn1XmlXerEncoder

Public Member Functions

 Asn1XerOutputStream (System.IO.Stream os)
 
 Asn1XerOutputStream (System.IO.Stream os, bool canonical, int bufSize)
 
virtual void Copy (byte data)
 
virtual void Copy (byte[] data)
 
virtual void Copy (byte[] data, int off, int len)
 
virtual void Copy (System.String data)
 
virtual void DecrLevel ()
 
virtual void EncodeBinStrValue (byte[] bits, int nbits)
 
virtual void EncodeByte (byte data)
 
virtual void EncodeData (System.String data)
 
virtual void EncodeEmptyElement (System.String elemName)
 
virtual void EncodeEndDocument ()
 
virtual void EncodeEndElement (System.String elemName)
 
virtual void EncodeHexStrValue (byte[] data)
 
virtual void EncodeNamedValue (System.String valueName, System.String elemName)
 
virtual void EncodeNamedValueElement (System.String elemName)
 
virtual void EncodeRealValue (double data, System.String elemName)
 
virtual void EncodeStartDocument ()
 
virtual void EncodeStartElement (System.String elemName)
 
virtual void IncrLevel ()
 
virtual void Indent ()
 
virtual bool IsCanonical ()
 
virtual void Write (System.String data)
 
- Public Member Functions inherited from Asn1OutputStream
 Asn1OutputStream (System.IO.Stream os)
 
override void Close ()
 
override void Flush ()
 
override int Read (byte[] buffer, int offset, int count)
 
override long Seek (long offset, System.IO.SeekOrigin origin)
 
override void SetLength (long value)
 
virtual void Write (byte[] b)
 
override void Write (System.Byte[] b, int off, int len)
 
void Write2Bytes (int value)
 
void Write4Bytes (int value)
 
virtual void WriteByte (int b)
 
override void WriteByte (byte b)
 
- Public Member Functions inherited from Asn1Writable
void Write (byte[] b, int off, int len)
 

Properties

virtual bool Canonical [set]
 
virtual int State [get, set]
 
- Properties inherited from Asn1OutputStream
override bool CanRead [get]
 
override bool CanSeek [get]
 
override bool CanWrite [get]
 
Asn1Context Context [get]
 
override long Length [get]
 
override long Position [get, set]
 
- Properties inherited from Asn1XerEncoder
int State [get, set]
 
- Properties inherited from Asn1XmlXerEncoder
Asn1Context Context [get]
 

Detailed Description

This class implements the output stream to encode ASN.1 messages as specified in the XML Encoding Rules (XER) as specified in the ITU-T X.693 standard. A reference to an object of this type is passed to each of the ASN.1 type encode methods involved in encoding a particular message type.

Constructor & Destructor Documentation

◆ Asn1XerOutputStream() [1/2]

Asn1XerOutputStream ( System.IO.Stream  os)

This constructor creates a buffered XER output stream object with default size of buffer. Whenever the buffer becomes full, the buffer will be flushed to the stream.

Parameters
osThe underlying System.IO.Stream object.

◆ Asn1XerOutputStream() [2/2]

Asn1XerOutputStream ( System.IO.Stream  os,
bool  canonical,
int  bufSize 
)

This constructor creates a buffered XER output stream object. Whenever the buffer becomes full, the buffer will be flushed to the stream.

Parameters
osThe underlying System.IO.Stream object.
canonicalBoolean indicating a canonical or non-canonical encoding should be produced as defined in the X.693 standard.
bufSizeThe buffer size. If it is 0 then the output stream is used as unbuffered.

Member Function Documentation

◆ Copy() [1/4]

virtual void Copy ( byte  data)
virtual

This method is used to copy a single byte to the output stream. It first converts the byte to a hex character representation and then copies it to the output buffer.

Throws, exception thrown by the underlying System.IO.Stream.

Parameters
dataThe byte value to copy

Implements Asn1XmlXerEncoder.

◆ Copy() [2/4]

virtual void Copy ( byte []  data)
virtual

This method copies multiple bytes to the output stream. It is assumed the byte are already formatted into a valid XML encoding type (for example, UTF-8).

Throws, exception thrown by the underlying System.IO.Stream.

Parameters
dataArray of bytes to copy to the output stream
Exceptions
Asn1ExceptionThrown, if operation is failed.

Implements Asn1XmlXerEncoder.

◆ Copy() [3/4]

virtual void Copy ( byte []  data,
int  off,
int  len 
)
virtual

This method copies multiple bytes to the output stream. It is assumed the byte are already formatted into a valid XML encoding type (for example, UTF-8).

Throws, exception thrown by the underlying System.IO.Stream.

Parameters
dataArray of bytes to copy to the output stream
offThe offset in array at which to begin copy.
lenThe Number of bytes to copy
Exceptions
Asn1ExceptionThrown, if operation is failed.

Implements Asn1XmlXerEncoder.

◆ Copy() [4/4]

virtual void Copy ( System.String  data)
virtual

This method copies a character string to the output stream.

Throws, exception thrown by the underlying System.IO.Stream.

Parameters
dataThe string value to copy
Exceptions
Asn1ExceptionThrown, if operation is failed.

Implements Asn1XmlXerEncoder.

◆ DecrLevel()

virtual void DecrLevel ( )
virtual

This method decrements the element nesting level counter.

Implements Asn1XmlXerEncoder.

◆ EncodeBinStrValue()

virtual void EncodeBinStrValue ( byte []  bits,
int  nbits 
)
virtual

This method encodes XML binary string data

Throws, exception thrown by the underlying System.IO.Stream.

Parameters
bitsBit String to encode
nbitsNumber of bits to encode
Exceptions
Asn1ExceptionThrown, if operation is failed.

Implements Asn1XmlXerEncoder.

References Asn1Util.URShift().

◆ EncodeByte()

virtual void EncodeByte ( byte  data)
virtual

This method is used to encode a single byte to the output stream. It first converts the byte to a hex character representation and then copies it to the output buffer.

Throws, exception thrown by the underlying System.IO.Stream.

Parameters
dataThe byte value to copy

Implements Asn1XmlXerEncoder.

◆ EncodeData()

virtual void EncodeData ( System.String  data)
virtual

This method encodes XML string data

Throws, exception thrown by the underlying System.IO.Stream.

Parameters
dataString value to encode
Exceptions
Asn1ExceptionThrown, if operation is failed.

Implements Asn1XmlXerEncoder.

References Asn1XerEncoder_Fields.XERDATA.

◆ EncodeEmptyElement()

virtual void EncodeEmptyElement ( System.String  elemName)
virtual

This method encodes an XML empty element tag.

Throws, exception thrown by the underlying System.IO.Stream.

Parameters
elemNameThe name of element.
Exceptions
Asn1ExceptionThrown, if operation is failed.

Implements Asn1XerEncoder.

References Asn1XerEncoder_Fields.XEREND.

◆ EncodeEndDocument()

virtual void EncodeEndDocument ( )
virtual

This method encodes standard trailor information at the end of the XML document.

Throws, exception thrown by the underlying System.IO.Stream.

Exceptions
Asn1ExceptionThrown, if operation is failed.

Implements Asn1XmlXerEncoder.

◆ EncodeEndElement()

virtual void EncodeEndElement ( System.String  elemName)
virtual

This method encodes an XML end element tag.

Throws, exception thrown by the underlying System.IO.Stream.

Parameters
elemNameThe name of element.
Exceptions
Asn1ExceptionThrown, if operation is failed.

Implements Asn1XerEncoder.

References Asn1XerEncoder_Fields.XEREND.

◆ EncodeHexStrValue()

virtual void EncodeHexStrValue ( byte []  data)
virtual

This method encodes XML hexadecimal string data

Throws, exception thrown by the underlying System.IO.Stream.

Parameters
dataData to encode
Exceptions
Asn1ExceptionThrown, if operation is failed.

Implements Asn1XmlXerEncoder.

◆ EncodeNamedValue()

virtual void EncodeNamedValue ( System.String  valueName,
System.String  elemName 
)
virtual

This method encodes an XML named value (with start and end tags).

Throws, exception thrown by the underlying System.IO.Stream.

Parameters
valueNameThe named value.
elemNameThe name of element.
Exceptions
Asn1ExceptionThrown, if operation is failed.

Implements Asn1XerEncoder.

◆ EncodeNamedValueElement()

virtual void EncodeNamedValueElement ( System.String  elemName)
virtual

This method encodes an XML named value element tag.

Throws, exception thrown by the underlying System.IO.Stream.

Parameters
elemNameThe name of element.
Exceptions
Asn1ExceptionThrown, if operation is failed.

Implements Asn1XmlXerEncoder.

References Asn1XerEncoder_Fields.XERDATA.

◆ EncodeRealValue()

virtual void EncodeRealValue ( double  data,
System.String  elemName 
)
virtual

This method encodes an XML REAL (double) value (with start and end tags).

Throws, exception thrown by the underlying System.IO.Stream.

Parameters
dataThe value to be encoded.
elemNameThe name of element. If null, then start and end tags won't be encoded.
Exceptions
Asn1ExceptionThrown, if operation is failed.

Implements Asn1XerEncoder.

References Asn1XerUtil.EncodeReal().

◆ EncodeStartDocument()

virtual void EncodeStartDocument ( )
virtual

This method encodes standard header information at the beginning of the XML document.

Throws, exception thrown by the underlying System.IO.Stream.

Exceptions
Asn1ExceptionThrown, if operation is failed.

Implements Asn1XmlXerEncoder.

◆ EncodeStartElement()

virtual void EncodeStartElement ( System.String  elemName)
virtual

This method encodes an XML start element tag.

Throws, exception thrown by the underlying System.IO.Stream.

Parameters
elemNameThe name of element.
Exceptions
Asn1ExceptionThrown, if operation is failed.

Implements Asn1XerEncoder.

References Asn1XerEncoder_Fields.XERSTART.

◆ IncrLevel()

virtual void IncrLevel ( )
virtual

This method increments the element nesting level counter.

Implements Asn1XmlXerEncoder.

◆ Indent()

virtual void Indent ( )
virtual

This methods indents by adding a new-line followed by whitespace corresponding to the current nesting level to the output stream.

Throws, exception thrown by the underlying System.IO.Stream.

Exceptions
Asn1ExceptionThrown, if operation is failed.

Implements Asn1XmlXerEncoder.

References Asn1XerEncoder_Fields.XERINDENT.

◆ IsCanonical()

virtual bool IsCanonical ( )
virtual

For XER, canonical mode turns off extra whitespace output.

Return true if the encoder has been put into canonical mode. For XML and XER, canonical mode signals the generated encoders to always encode ASN.1 elements that have a DEFAULT value.

Implements Asn1XmlXerEncoder.

◆ Write()

virtual void Write ( System.String  data)
virtual

This method copies a character string to the output stream.

Throws, exception thrown by the underlying System.IO.Stream.

Parameters
dataThe string value to copy
Exceptions
Asn1ExceptionThrown, if operation is failed.

References Asn1Util.WriteStackTrace().

Property Documentation

◆ Canonical

virtual bool Canonical
set

Sets the canonical encoding rule.

Value: true if canonical encoding; otherwise false.

◆ State

virtual int State
getset

Sets the state of the buffer.

Value: buffer stat