Class XmlRpcMessage

Represents a remote procedure call that can be sent using the XmlRpcClient class.

Inheritance

System.Object

XmlRpcMessage

Implements

System.IComparable

Inherited Members

System.Object.Equals(System.Object, System.Object)

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

Namespace: Argotic.Net

Assembly: Argotic.Core.dll

Syntax

[Serializable]
public class XmlRpcMessage : IComparable

Examples

Constructors

| Improve this Doc View Source

XmlRpcMessage()

Initializes a new instance of the XmlRpcMessage class.

Declaration

public XmlRpcMessage()

| Improve this Doc View Source

XmlRpcMessage(String)

Initializes a new instance of the XmlRpcMessage class using the specified method name.

Declaration

public XmlRpcMessage(string methodName)

Parameters

Type	Name	Description
System.String	methodName	The name of the method to be called.

Exceptions

Type	Condition
System.ArgumentNullException	The `methodName` is a null reference (Nothing in Visual Basic).
System.ArgumentNullException	The `methodName` is an empty string.

| Improve this Doc View Source

XmlRpcMessage(String, Collection<IXmlRpcValue>)

Initializes a new instance of the XmlRpcMessage class using the specified method name and parameters.

Declaration

public XmlRpcMessage(string methodName, Collection<IXmlRpcValue> parameters)

Parameters

Type	Name	Description
System.String	methodName	The name of the method to be called.
System.Collections.ObjectModel.Collection<IXmlRpcValue>	parameters	A System.Collections.ObjectModel.Collection<T> collection of IXmlRpcValue objects that represent the method parameters.

Exceptions

Type	Condition
System.ArgumentNullException	The `methodName` is a null reference (Nothing in Visual Basic).
System.ArgumentNullException	The `methodName` is an empty string.
System.ArgumentNullException	The `parameters` is a null reference (Nothing in Visual Basic).

Properties

| Improve this Doc View Source

Encoding

Gets or sets the Encoding of this message.

Declaration

public Encoding Encoding { get; set; }

Property Value

Type	Description
System.Text.Encoding	A Encoding that specifies the character encoding of this message. The default value is System.Text.UTF8Encoding.

Exceptions

Type	Condition
System.ArgumentNullException	The `value` is a null reference (Nothing in Visual Basic).

| Improve this Doc View Source

MethodName

Gets or sets the name of the method to be called.

Declaration

public string MethodName { get; set; }

Property Value

Type	Description
System.String	The name of the method to be called.

Exceptions

Type	Condition
System.ArgumentNullException	The `value` is a null reference (Nothing in Visual Basic).
System.ArgumentNullException	The `value` is an empty string.

| Improve this Doc View Source

Parameters

Gets the method parameters.

Declaration

public Collection<IXmlRpcValue> Parameters { get; }

Property Value

Type	Description
System.Collections.ObjectModel.Collection<IXmlRpcValue>	A System.Collections.ObjectModel.Collection<T> collection of IXmlRpcValue objects that represent the method parameters. The default value is an empty collection.

Methods

| Improve this Doc View Source

CompareSequence(Collection<IXmlRpcValue>, Collection<IXmlRpcValue>)

Compares two specified System.Collections.ObjectModel.Collection<T> collections.

Declaration

public static int CompareSequence(Collection<IXmlRpcValue> source, Collection<IXmlRpcValue> target)

Parameters

Type	Name	Description
System.Collections.ObjectModel.Collection<IXmlRpcValue>	source	The first collection.
System.Collections.ObjectModel.Collection<IXmlRpcValue>	target	The second collection.

Returns

Type	Description
System.Int32	A 32-bit signed integer indicating the lexical relationship between the two comparands.

Remarks

If the collections contain the same number of elements, determines the lexical relationship between the two sequences of comparands.

If the source has an element count that is greater than the target element count, returns 1.

If the source has an element count that is less than the target element count, returns -1.

Exceptions

Type	Condition
System.ArgumentNullException	The `source` is a null reference (Nothing in Visual Basic).
System.ArgumentNullException	The `target` is a null reference (Nothing in Visual Basic).

| Improve this Doc View Source

CompareTo(Object)

Compares the current instance with another object of the same type.

Declaration

public int CompareTo(object obj)

Parameters

Type	Name	Description
System.Object	obj	An object to compare with this instance.

Returns

Type	Description
System.Int32	A 32-bit signed integer that indicates the relative order of the objects being compared.

Exceptions

Type	Condition
System.ArgumentException	The `obj` is not the expected System.Type.

| Improve this Doc View Source

Equals(Object)

Determines whether the specified System.Object is equal to the current instance.

Declaration

public override bool Equals(object obj)

Parameters

Type	Name	Description
System.Object	obj	The System.Object to compare with the current instance.

Returns

Type	Description
System.Boolean	true if the specified System.Object is equal to the current instance; otherwise, false.

Overrides

System.Object.Equals(System.Object)

| Improve this Doc View Source

GetHashCode()

Returns a hash code for the current instance.

Declaration

public override int GetHashCode()

Returns

Type	Description
System.Int32	A 32-bit signed integer hash code.

Overrides

System.Object.GetHashCode()

| Improve this Doc View Source

Load(XPathNavigator)

Loads this XmlRpcMessage using the supplied System.Xml.XPath.XPathNavigator.

Declaration

public bool Load(XPathNavigator source)

Parameters

Type	Name	Description
System.Xml.XPath.XPathNavigator	source	The System.Xml.XPath.XPathNavigator to extract information from.

Returns

Type	Description
System.Boolean	true if the XmlRpcMessage was initialized using the supplied `source`, otherwise false.

Remarks

This method expects the supplied source to be positioned on the XML element that represents a XmlRpcMessage.

Exceptions

Type	Condition
System.ArgumentNullException	The `source` is a null reference (Nothing in Visual Basic).

| Improve this Doc View Source

ToString()

Returns a System.String that represents the current XmlRpcMessage.

Declaration

public override string ToString()

Returns

Type	Description
System.String	A System.String that represents the current XmlRpcMessage.

Overrides

System.Object.ToString()

Remarks

This method returns the XML representation for the current instance.

| Improve this Doc View Source

WriteTo(XmlWriter)

Saves the current XmlRpcMessage to the specified System.Xml.XmlWriter.

Declaration

public void WriteTo(XmlWriter writer)

Parameters

Type	Name	Description
System.Xml.XmlWriter	writer	The System.Xml.XmlWriter to which you want to save.

Exceptions

Type	Condition
System.ArgumentNullException	The `writer` is a null reference (Nothing in Visual Basic).

Operators

| Improve this Doc View Source

Equality(XmlRpcMessage, XmlRpcMessage)

Determines if operands are equal.

Declaration

public static bool operator ==(XmlRpcMessage first, XmlRpcMessage second)

Parameters

Type	Name	Description
XmlRpcMessage	first	Operand to be compared.
XmlRpcMessage	second	Operand to compare to.

Returns

Type	Description
System.Boolean	true if the values of its operands are equal, otherwise; false.

| Improve this Doc View Source

GreaterThan(XmlRpcMessage, XmlRpcMessage)

Determines if first operand is greater than second operand.

Declaration

public static bool operator>(XmlRpcMessage first, XmlRpcMessage second)

Parameters

Type	Name	Description
XmlRpcMessage	first	Operand to be compared.
XmlRpcMessage	second	Operand to compare to.

Returns

Type	Description
System.Boolean	true if the first operand is greater than the second, otherwise; false.

| Improve this Doc View Source

Inequality(XmlRpcMessage, XmlRpcMessage)

Determines if operands are not equal.

Declaration

public static bool operator !=(XmlRpcMessage first, XmlRpcMessage second)

Parameters

Type	Name	Description
XmlRpcMessage	first	Operand to be compared.
XmlRpcMessage	second	Operand to compare to.

Returns

Type	Description
System.Boolean	false if its operands are equal, otherwise; true.

| Improve this Doc View Source

LessThan(XmlRpcMessage, XmlRpcMessage)

Determines if first operand is less than second operand.

Declaration

public static bool operator <(XmlRpcMessage first, XmlRpcMessage second)

Parameters

Type	Name	Description
XmlRpcMessage	first	Operand to be compared.
XmlRpcMessage	second	Operand to compare to.

Returns

Type	Description
System.Boolean	true if the first operand is less than the second, otherwise; false.

Implements

System.IComparable