Asn1XmlXerEncoder Interface Reference

Inheritance diagram for Asn1XmlXerEncoder:
Asn1XerEncoder Asn1XmlEncoder Asn1XerEncodeBuffer Asn1XerOutputStream Asn1XmlEncodeBuffer Asn1XmlOutputStream

List of all members.

Public Member Functions

void Copy (System.String data)
void Copy (byte[] data, int off, int len)
void Copy (byte[] data)
void Copy (byte data)
void DecrLevel ()
void EncodeBinStrValue (byte[] bits, int nbits)
void EncodeByte (byte data)
void EncodeData (System.String data)
void EncodeEndDocument ()
void EncodeHexStrValue (byte[] data)
void EncodeNamedValueElement (System.String elemName)
void EncodeStartDocument ()
void IncrLevel ()
void Indent ()

Properties

Asn1Context Context [get]

Detailed Description

This is a base interface for encoding of ASN.1 messages as XML as specified in the W3C standard. It is implemented by both the Asn1XmlEncodeBuffer and Asn1XmlOutputStream.


Member Function Documentation

void Copy ( System.String  data  ) 

This method copies a character string to the encode buffer or stream.

Throws C# Exception, If I/O error occurs.

Parameters:
data The string value to copy
Exceptions:
Asn1Exception Thrown, if operation is failed.

Implemented in Asn1XerEncodeBuffer, Asn1XerOutputStream, Asn1XmlEncodeBuffer, and Asn1XmlOutputStream.

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

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

Throws C# Exception, If I/O error occurs.

Parameters:
data Array of bytes to copy to the encode buffer
off The offset in array at which to begin copy.
len The number of bytes to copy
Exceptions:
Asn1Exception Thrown, if operation is failed.

Implemented in Asn1XerEncodeBuffer, Asn1XerOutputStream, Asn1XmlEncodeBuffer, and Asn1XmlOutputStream.

void Copy ( byte[]  data  ) 

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

Throws C# Exception, If I/O error occurs.

Parameters:
data Array of bytes to copy to the encode buffer
Exceptions:
Asn1Exception Thrown, if operation is failed.

Implemented in Asn1XerEncodeBuffer, Asn1XerOutputStream, Asn1XmlEncodeBuffer, and Asn1XmlOutputStream.

void Copy ( byte  data  ) 

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

Throws C# Exception, If I/O error occurs.

Parameters:
data The byte value to copy

Implemented in Asn1XerEncodeBuffer, Asn1XerOutputStream, Asn1XmlEncodeBuffer, and Asn1XmlOutputStream.

void DecrLevel (  ) 

This method decrements the element nesting level counter.

Implemented in Asn1XerEncodeBuffer, Asn1XerOutputStream, Asn1XmlEncodeBuffer, and Asn1XmlOutputStream.

void EncodeBinStrValue ( byte[]  bits,
int  nbits 
)

This method encodes XML binary string data

Throws C# Exception, If I/O error occurs.

Parameters:
bits Bit String to encode
nbits Number of bits to encode
Exceptions:
Asn1Exception Thrown, if operation is failed.

Implemented in Asn1XerEncodeBuffer, Asn1XerOutputStream, Asn1XmlEncodeBuffer, and Asn1XmlOutputStream.

void EncodeByte ( byte  data  ) 

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

Parameters:
data The byte value to copy

Implemented in Asn1XerEncodeBuffer, Asn1XerOutputStream, Asn1XmlEncodeBuffer, and Asn1XmlOutputStream.

void EncodeData ( System.String  data  ) 

This method encodes XML string data

Throws C# Exception, If I/O error occurs.

Parameters:
data String value to encode
Exceptions:
Asn1Exception Thrown, if operation is failed.

Implemented in Asn1XerEncodeBuffer, Asn1XerOutputStream, Asn1XmlEncodeBuffer, and Asn1XmlOutputStream.

void EncodeEndDocument (  ) 

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

Throws C# Exception, If I/O error occurs.

Exceptions:
Asn1Exception Thrown, if operation is failed.

Implemented in Asn1XerEncodeBuffer, Asn1XerOutputStream, Asn1XmlEncodeBuffer, and Asn1XmlOutputStream.

void EncodeHexStrValue ( byte[]  data  ) 

This method encodes XML hexadecimal string data

Throws C# Exception, If I/O error occurs.

Parameters:
data Data to encode
Exceptions:
Asn1Exception Thrown, if operation is failed.

Implemented in Asn1XerEncodeBuffer, Asn1XerOutputStream, Asn1XmlEncodeBuffer, and Asn1XmlOutputStream.

void EncodeNamedValueElement ( System.String  elemName  ) 

This method encodes an XML named value element tag.

Throws C# Exception, If I/O error occurs.

Parameters:
elemName The name of element.
Exceptions:
Asn1Exception Thrown, if operation is failed.

Implemented in Asn1XerEncodeBuffer, Asn1XerOutputStream, Asn1XmlEncodeBuffer, and Asn1XmlOutputStream.

void EncodeStartDocument (  ) 

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

Throws C# Exception, If I/O error occurs.

Exceptions:
Asn1Exception Thrown, if operation is failed.

Implemented in Asn1XerEncodeBuffer, Asn1XerOutputStream, Asn1XmlEncodeBuffer, and Asn1XmlOutputStream.

void IncrLevel (  ) 

This method increments the element nesting level counter.

Implemented in Asn1XerEncodeBuffer, Asn1XerOutputStream, Asn1XmlEncodeBuffer, and Asn1XmlOutputStream.

void Indent (  ) 

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

Throws C# Exception, If I/O error occurs.

Exceptions:
Asn1Exception Thrown, if operation is failed.

Implemented in Asn1XerEncodeBuffer, Asn1XerOutputStream, Asn1XmlEncodeBuffer, and Asn1XmlOutputStream.


Property Documentation

Asn1Context Context [get]

The Asn1Context associated with this encoder