Class XmlRpcMessageSentEventArgs
Provides data for the SendCompleted event.
Inheritance
Implements
Inherited Members
Namespace: Argotic.Net
Assembly: Argotic.Core.dll
Syntax
[Serializable]
public class XmlRpcMessageSentEventArgs : EventArgs, IComparable
Remarks
A SendCompleted event occurs whenever the SendAsync(XmlRpcMessage, Object) method is called.
Constructors
| Improve this Doc View SourceXmlRpcMessageSentEventArgs()
Initializes a new instance of the XmlRpcMessageSentEventArgs class.
Declaration
public XmlRpcMessageSentEventArgs()
XmlRpcMessageSentEventArgs(Uri, XmlRpcMessage, XmlRpcResponse, WebRequestOptions, Object)
Initializes a new instance of the XmlRpcMessageSentEventArgs class using the supplied parameters.
Declaration
public XmlRpcMessageSentEventArgs(Uri host, XmlRpcMessage message, XmlRpcResponse response, WebRequestOptions options, object state)
Parameters
Type | Name | Description |
---|---|---|
System.Uri | host | A System.Uri that represents the URL of the host computer used for the XML-RPC transaction. |
XmlRpcMessage | message | An XmlRpcMessage that represents the remote procedure call payload. |
XmlRpcResponse | response | An XmlRpcResponse that represents the response to the remote procedure call. |
WebRequestOptions | options | A WebRequestOptions that holds options that should be applied to web requests. |
System.Object | state | A System.Object containing state information that was passed to the asynchronous send operation. This parameter may be null. |
Exceptions
Type | Condition |
---|---|
System.ArgumentNullException | The |
System.ArgumentNullException | The |
System.ArgumentNullException | The |
XmlRpcMessageSentEventArgs(Uri, XmlRpcMessage, XmlRpcResponse, ICredentials, IWebProxy, Object)
Initializes a new instance of the XmlRpcMessageSentEventArgs class using the supplied parameters.
Declaration
public XmlRpcMessageSentEventArgs(Uri host, XmlRpcMessage message, XmlRpcResponse response, ICredentials credentials, IWebProxy proxy, object state)
Parameters
Type | Name | Description |
---|---|---|
System.Uri | host | A System.Uri that represents the URL of the host computer used for the XML-RPC transaction. |
XmlRpcMessage | message | An XmlRpcMessage that represents the remote procedure call payload. |
XmlRpcResponse | response | An XmlRpcResponse that represents the response to the remote procedure call. |
System.Net.ICredentials | credentials | A System.Net.ICredentials that represents the authentication credentials utilized by the client when making the remote procedure call. This parameter may be null. |
System.Net.IWebProxy | proxy | A System.Net.IWebProxy that represents the web proxy utilized by the client to proxy the remote procedure call. This parameter may be null. |
System.Object | state | A System.Object containing state information that was passed to the asynchronous send operation. This parameter may be null. |
Exceptions
Type | Condition |
---|---|
System.ArgumentNullException | The |
System.ArgumentNullException | The |
System.ArgumentNullException | The |
Properties
| Improve this Doc View SourceCredentials
Gets the authentication credentials utilized by the client when making the remote procedure call.
Declaration
public ICredentials Credentials { get; }
Property Value
Type | Description |
---|---|
System.Net.ICredentials | A System.Net.ICredentials that represents the authentication credentials utilized by the client when making the remote procedure call. If no credentials were provided, returns null. |
Empty
Represents an syndication resource loaded event with no event data.
Declaration
public static XmlRpcMessageSentEventArgs Empty { get; }
Property Value
Type | Description |
---|---|
XmlRpcMessageSentEventArgs | An uninitialized instance of the XmlRpcMessageSentEventArgs class. |
Remarks
The value of Empty is a read-only instance of XmlRpcMessageSentEventArgs equivalent to the result of calling the XmlRpcMessageSentEventArgs() constructor.
Host
Gets the the location of the host computer that the remote procedure call was sent to.
Declaration
public Uri Host { get; }
Property Value
Type | Description |
---|---|
System.Uri | A System.Uri that represents the URL of the host computer used for the XML-RPC transaction. |
Message
Gets the remote procedure call payload that was sent.
Declaration
public XmlRpcMessage Message { get; }
Property Value
Type | Description |
---|---|
XmlRpcMessage | An XmlRpcMessage that represents the remote procedure call payload. |
Proxy
Gets the web proxy utilized by the client to proxy the remote procedure call.
Declaration
public IWebProxy Proxy { get; }
Property Value
Type | Description |
---|---|
System.Net.IWebProxy | A System.Net.IWebProxy that represents the web proxy utilized by the client to proxy the remote procedure call. If no proxy was used, returns null. |
Response
Gets the response to the remote procedure call.
Declaration
public XmlRpcResponse Response { get; }
Property Value
Type | Description |
---|---|
XmlRpcResponse | An XmlRpcResponse that represents the response to the remote procedure call. |
State
Gets an System.Object containing state information that was passed to the asynchronous send operation.
Declaration
public object State { get; }
Property Value
Type | Description |
---|---|
System.Object | A System.Object containing state information that was passed to the asynchronous send operation. If no user token provided, returns null. |
Methods
| Improve this Doc View SourceCompareTo(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 |
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
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
ToString()
Returns a System.String that represents the current XmlRpcMessageSentEventArgs.
Declaration
public override string ToString()
Returns
Type | Description |
---|---|
System.String | A System.String that represents the current XmlRpcMessageSentEventArgs. |
Overrides
Remarks
This method returns a human-readable string for the current instance. Hash code values are displayed for applicable properties.
Operators
| Improve this Doc View SourceEquality(XmlRpcMessageSentEventArgs, XmlRpcMessageSentEventArgs)
Determines if operands are equal.
Declaration
public static bool operator ==(XmlRpcMessageSentEventArgs first, XmlRpcMessageSentEventArgs second)
Parameters
Type | Name | Description |
---|---|---|
XmlRpcMessageSentEventArgs | first | Operand to be compared. |
XmlRpcMessageSentEventArgs | second | Operand to compare to. |
Returns
Type | Description |
---|---|
System.Boolean | true if the values of its operands are equal, otherwise; false. |
GreaterThan(XmlRpcMessageSentEventArgs, XmlRpcMessageSentEventArgs)
Determines if first operand is greater than second operand.
Declaration
public static bool operator>(XmlRpcMessageSentEventArgs first, XmlRpcMessageSentEventArgs second)
Parameters
Type | Name | Description |
---|---|---|
XmlRpcMessageSentEventArgs | first | Operand to be compared. |
XmlRpcMessageSentEventArgs | second | Operand to compare to. |
Returns
Type | Description |
---|---|
System.Boolean | true if the first operand is greater than the second, otherwise; false. |
Inequality(XmlRpcMessageSentEventArgs, XmlRpcMessageSentEventArgs)
Determines if operands are not equal.
Declaration
public static bool operator !=(XmlRpcMessageSentEventArgs first, XmlRpcMessageSentEventArgs second)
Parameters
Type | Name | Description |
---|---|---|
XmlRpcMessageSentEventArgs | first | Operand to be compared. |
XmlRpcMessageSentEventArgs | second | Operand to compare to. |
Returns
Type | Description |
---|---|
System.Boolean | false if its operands are equal, otherwise; true. |
LessThan(XmlRpcMessageSentEventArgs, XmlRpcMessageSentEventArgs)
Determines if first operand is less than second operand.
Declaration
public static bool operator <(XmlRpcMessageSentEventArgs first, XmlRpcMessageSentEventArgs second)
Parameters
Type | Name | Description |
---|---|---|
XmlRpcMessageSentEventArgs | first | Operand to be compared. |
XmlRpcMessageSentEventArgs | second | Operand to compare to. |
Returns
Type | Description |
---|---|
System.Boolean | true if the first operand is less than the second, otherwise; false. |