diff --git a/SallyConnect/bin/Debug/Apache.NMS.ActiveMQ.dll b/SallyConnect/bin/Debug/Apache.NMS.ActiveMQ.dll
deleted file mode 100644
index 9e5e5a5c209e48bb4b3c5f1b85ae7629ef763e3b..0000000000000000000000000000000000000000
Binary files a/SallyConnect/bin/Debug/Apache.NMS.ActiveMQ.dll and /dev/null differ
diff --git a/SallyConnect/bin/Debug/Apache.NMS.ActiveMQ.pdb b/SallyConnect/bin/Debug/Apache.NMS.ActiveMQ.pdb
deleted file mode 100644
index 362d0a8c2e5f2f35b1221a1232d0cd7e702229b9..0000000000000000000000000000000000000000
Binary files a/SallyConnect/bin/Debug/Apache.NMS.ActiveMQ.pdb and /dev/null differ
diff --git a/SallyConnect/bin/Debug/Apache.NMS.ActiveMQ.xml b/SallyConnect/bin/Debug/Apache.NMS.ActiveMQ.xml
deleted file mode 100644
index d388e307b238d4d24601c7aaa48fc176baf27390..0000000000000000000000000000000000000000
--- a/SallyConnect/bin/Debug/Apache.NMS.ActiveMQ.xml
+++ /dev/null
@@ -1,12301 +0,0 @@
-<?xml version="1.0"?>
-<doc>
- <assembly>
- <name>Apache.NMS.ActiveMQ</name>
- </assembly>
- <members>
- <member name="T:Apache.NMS.ActiveMQ.Commands.BaseDataStructure">
- <summary>
- Base class for all DataStructure implementations
- </summary>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.Commands.DataStructure">
- <summary>
- An OpenWire command
- </summary>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.Commands.Command">
- <summary>
- An OpenWire command
- </summary>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.Commands.MarshallAware">
- <summary>
- Represents a marshallable entity
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.Message.GetDataStructureType">
-
- <summery>
- Get the unique identifier that this object and its own
- Marshaler share.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.Message.Clone">
-
- <summery>
- Clone this object and return a new instance that the caller now owns.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.Message.ToString">
-
- <summery>
- Returns a string containing the information for this DataStructure
- such as its type and value of its elements.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.Message.Visit(Apache.NMS.ActiveMQ.State.ICommandVisitor)">
-
- <summery>
- Allows a Visitor to visit this command and return a response to the
- command based on the command type being visited. The command will call
- the proper processXXX method in the visitor.
- </summery>
-
- </member>
- <member name="P:Apache.NMS.ActiveMQ.Commands.Message.IsMessage">
-
- <summery>
- Return an answer of true to the isMessage() query.
- </summery>
-
- </member>
- <member name="P:Apache.NMS.ActiveMQ.Commands.ActiveMQMessage.NMSCorrelationID">
- <summary>
- The correlation ID used to correlate messages with conversations or long running business processes
- </summary>
- </member>
- <member name="P:Apache.NMS.ActiveMQ.Commands.ActiveMQMessage.NMSDestination">
- <summary>
- The destination of the message
- </summary>
- </member>
- <member name="P:Apache.NMS.ActiveMQ.Commands.ActiveMQMessage.NMSTimeToLive">
- <summary>
- The time in milliseconds that this message should expire in
- </summary>
- </member>
- <member name="P:Apache.NMS.ActiveMQ.Commands.ActiveMQMessage.NMSMessageId">
- <summary>
- The message ID which is set by the provider
- </summary>
- </member>
- <member name="P:Apache.NMS.ActiveMQ.Commands.ActiveMQMessage.NMSDeliveryMode">
- <summary>
- Whether or not this message is persistent
- </summary>
- </member>
- <member name="P:Apache.NMS.ActiveMQ.Commands.ActiveMQMessage.NMSPriority">
- <summary>
- The Priority on this message
- </summary>
- </member>
- <member name="P:Apache.NMS.ActiveMQ.Commands.ActiveMQMessage.NMSRedelivered">
- <summary>
- Returns true if this message has been redelivered to this or another consumer before being acknowledged successfully.
- </summary>
- </member>
- <member name="P:Apache.NMS.ActiveMQ.Commands.ActiveMQMessage.NMSReplyTo">
- <summary>
- The destination that the consumer of this message should send replies to
- </summary>
- </member>
- <member name="P:Apache.NMS.ActiveMQ.Commands.ActiveMQMessage.NMSTimestamp">
- <summary>
- The timestamp the broker added to the message
- </summary>
- </member>
- <member name="P:Apache.NMS.ActiveMQ.Commands.ActiveMQMessage.NMSType">
- <summary>
- The type name of this message
- </summary>
- </member>
- <member name="P:Apache.NMS.ActiveMQ.Commands.ActiveMQMessage.NMSXDeliveryCount">
- <summary>
- Returns the number of times this message has been redelivered to other consumers without being acknowledged successfully.
- </summary>
- </member>
- <member name="P:Apache.NMS.ActiveMQ.Commands.ActiveMQMessage.NMSXGroupID">
- <summary>
- The Message Group ID used to group messages together to the same consumer for the same group ID value
- </summary>
- </member>
- <member name="P:Apache.NMS.ActiveMQ.Commands.ActiveMQMessage.NMSXGroupSeq">
- <summary>
- The Message Group Sequence counter to indicate the position in a group
- </summary>
- </member>
- <member name="P:Apache.NMS.ActiveMQ.Commands.ActiveMQMessage.NMSXProducerTXID">
- <summary>
- Returns the ID of the producers transaction
- </summary>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.Commands.ActiveMQBytesMessage.LengthTrackerStream">
- <summary>
- Used when the message compression is enabled to track how many bytes
- the EndianBinaryWriter actually writes to the stream before compression
- so that the receiving client can read off the real bodylength from the
- Message before the data is actually read.
- </summary>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.Commands.ActiveMQDestination">
- <summary>
- Summary description for ActiveMQDestination.
- </summary>
- </member>
- <member name="F:Apache.NMS.ActiveMQ.Commands.ActiveMQDestination.ACTIVEMQ_TOPIC">
- <summary>
- Topic Destination object
- </summary>
- </member>
- <member name="F:Apache.NMS.ActiveMQ.Commands.ActiveMQDestination.ACTIVEMQ_TEMPORARY_TOPIC">
- <summary>
- Temporary Topic Destination object
- </summary>
- </member>
- <member name="F:Apache.NMS.ActiveMQ.Commands.ActiveMQDestination.ACTIVEMQ_QUEUE">
- <summary>
- Queue Destination object
- </summary>
- </member>
- <member name="F:Apache.NMS.ActiveMQ.Commands.ActiveMQDestination.ACTIVEMQ_TEMPORARY_QUEUE">
- <summary>
- Temporary Queue Destination object
- </summary>
- </member>
- <member name="F:Apache.NMS.ActiveMQ.Commands.ActiveMQDestination.ADVISORY_PREFIX">
- <summary>
- prefix for Advisory message destinations
- </summary>
- </member>
- <member name="F:Apache.NMS.ActiveMQ.Commands.ActiveMQDestination.CONSUMER_ADVISORY_PREFIX">
- <summary>
- prefix for consumer advisory destinations
- </summary>
- </member>
- <member name="F:Apache.NMS.ActiveMQ.Commands.ActiveMQDestination.PRODUCER_ADVISORY_PREFIX">
- <summary>
- prefix for producer advisory destinations
- </summary>
- </member>
- <member name="F:Apache.NMS.ActiveMQ.Commands.ActiveMQDestination.CONNECTION_ADVISORY_PREFIX">
- <summary>
- prefix for connection advisory destinations
- </summary>
- </member>
- <member name="F:Apache.NMS.ActiveMQ.Commands.ActiveMQDestination.DEFAULT_ORDERED_TARGET">
- <summary>
- The default target for ordered destinations
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.ActiveMQDestination.#ctor">
- <summary>
- The Default Constructor
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.ActiveMQDestination.#ctor(System.String)">
- <summary>
- Construct the Destination with a defined physical name;
- </summary>
- <param name="name"></param>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.ActiveMQDestination.IsAdvisory">
- <summary>
- </summary>
- <returns>Returns the advisory.</returns>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.ActiveMQDestination.SetAdvisory(System.Boolean)">
- <summary>
- </summary>
- <param name="advisory">The advisory to set.</param>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.ActiveMQDestination.IsConsumerAdvisory">
- <summary>
- </summary>
- <returns>true if this is a destination for Consumer advisories</returns>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.ActiveMQDestination.IsProducerAdvisory">
- <summary>
- </summary>
- <returns>true if this is a destination for Producer advisories</returns>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.ActiveMQDestination.IsConnectionAdvisory">
- <summary>
- </summary>
- <returns>true if this is a destination for Connection advisories</returns>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.ActiveMQDestination.IsExclusive">
- <summary>
- </summary>
- <returns>Returns the exclusive.</returns>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.ActiveMQDestination.SetExclusive(System.Boolean)">
- <summary>
- </summary>
- <param name="exclusive">The exclusive to set.</param>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.ActiveMQDestination.IsOrdered">
- <summary>
- </summary>
- <returns>Returns the ordered.</returns>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.ActiveMQDestination.SetOrdered(System.Boolean)">
- <summary>
- </summary>
- <param name="ordered">The ordered to set.</param>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.ActiveMQDestination.GetOrderedTarget">
- <summary>
- </summary>
- <returns>Returns the orderedTarget.</returns>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.ActiveMQDestination.SetOrderedTarget(System.String)">
- <summary>
- </summary>
- <param name="orderedTarget">The orderedTarget to set.</param>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.ActiveMQDestination.Inspect(Apache.NMS.ActiveMQ.Commands.ActiveMQDestination)">
- <summary>
- A helper method to return a descriptive string for the topic or queue
- </summary>
- <param name="destination"></param>
- <returns>a descriptive string for this queue or topic</returns>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.ActiveMQDestination.Transform(Apache.NMS.IDestination)">
- <summary>
- </summary>
- <param name="destination"></param>
- <returns></returns>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.ActiveMQDestination.CreateDestination(System.Int32,System.String)">
- <summary>
- Create a Destination
- </summary>
- <param name="type"></param>
- <param name="pyhsicalName"></param>
- <returns></returns>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.ActiveMQDestination.CreateTemporaryName(System.String)">
- <summary>
- Create a temporary name from the clientId
- </summary>
- <param name="clientId"></param>
- <returns></returns>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.ActiveMQDestination.GetClientId(Apache.NMS.ActiveMQ.Commands.ActiveMQDestination)">
- <summary>
- From a temporary destination find the clientId of the Connection that created it
- </summary>
- <param name="destination"></param>
- <returns>the clientId or null if not a temporary destination</returns>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.ActiveMQDestination.CompareTo(System.Object)">
- <summary>
- </summary>
- <param name="o">object to compare</param>
- <returns>1 if this is less than o else 0 if they are equal or -1 if this is less than o</returns>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.ActiveMQDestination.CompareTo(Apache.NMS.ActiveMQ.Commands.ActiveMQDestination)">
- <summary>
- Lets sort by name first then lets sort topics greater than queues
- </summary>
- <param name="that">another destination to compare against</param>
- <returns>1 if this is less than o else 0 if they are equal or -1 if this is less than o</returns>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.ActiveMQDestination.GetDestinationType">
- <summary>
- </summary>
- <returns>Returns the Destination type</returns>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.ActiveMQDestination.GetDestinationTypeAsString">
- <summary>
- Gets the Destination Type of this Destination as a String value which is one
- of {Queue,Topic,TempQueue,TempTopic}.
- </summary>
- <returns>
- The Destination Type as a String.
- </returns>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.ActiveMQDestination.ToString">
- <summary>
- </summary>
- <returns>string representation of this instance</returns>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.ActiveMQDestination.GetHashCode">
- <summary>
- </summary>
- <returns>hashCode for this instance</returns>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.ActiveMQDestination.Equals(System.Object)">
- <summary>
- if the object passed in is equivalent, return true
- </summary>
- <param name="obj">the object to compare</param>
- <returns>true if this instance and obj are equivalent</returns>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.ActiveMQDestination.IsWildcard">
- <summary>
- </summary>
- <returns>true if the destination matches multiple possible destinations</returns>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.ActiveMQDestination.CreateDestination(System.String)">
- <summary>
- Factory method to create a child destination if this destination is a composite
- </summary>
- <param name="name"></param>
- <returns>the created Destination</returns>
- </member>
- <member name="P:Apache.NMS.ActiveMQ.Commands.ActiveMQDestination.Options">
- <summary>
- Dictionary of name/value pairs representing option values specified
- in the URI used to create this Destination. A null value is returned
- if no options were specified.
- </summary>
- </member>
- <member name="P:Apache.NMS.ActiveMQ.Commands.ActiveMQDestination.IsComposite">
- <summary>
- Returns true if this destination represents a collection of
- destinations; allowing a set of destinations to be published to or subscribed
- from in one NMS operation.
- <p/>
- If this destination is a composite then you can call {@link #getChildDestinations()}
- to return the list of child destinations.
- </summary>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.Commands.ActiveMQQueue">
- <summary>
- Summary description for ActiveMQQueue.
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.ActiveMQTempDestination.GetDestinationType">
- <summary>
- Method GetDestinationType
- </summary>
- <returns>An int</returns>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.ActiveMQTempDestination.CreateDestination(System.String)">
- <summary>
- Method CreateDestination
- </summary>
- <returns>An ActiveMQDestination</returns>
- <param name="name">A String</param>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.Commands.ActiveMQTempQueue">
- <summary>
- A Temporary Queue
- </summary>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.Commands.ActiveMQTempTopic">
- <summary>
- A Temporary Topic
- </summary>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.Commands.ActiveMQTopic">
- <summary>
- Summary description for ActiveMQTopic.
- </summary>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.Commands.BrokerError">
- <summary>
- Represents an exception on the broker
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.BrokerId.GetDataStructureType">
-
- <summery>
- Get the unique identifier that this object and its own
- Marshaler share.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.BrokerId.ToString">
-
- <summery>
- Returns a string containing the information for this DataStructure
- such as its type and value of its elements.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.BrokerInfo.GetDataStructureType">
-
- <summery>
- Get the unique identifier that this object and its own
- Marshaler share.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.BrokerInfo.ToString">
-
- <summery>
- Returns a string containing the information for this DataStructure
- such as its type and value of its elements.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.BrokerInfo.Visit(Apache.NMS.ActiveMQ.State.ICommandVisitor)">
-
- <summery>
- Allows a Visitor to visit this command and return a response to the
- command based on the command type being visited. The command will call
- the proper processXXX method in the visitor.
- </summery>
-
- </member>
- <member name="P:Apache.NMS.ActiveMQ.Commands.BrokerInfo.IsBrokerInfo">
-
- <summery>
- Return an answer of true to the isBrokerInfo() query.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.ConnectionControl.GetDataStructureType">
-
- <summery>
- Get the unique identifier that this object and its own
- Marshaler share.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.ConnectionControl.ToString">
-
- <summery>
- Returns a string containing the information for this DataStructure
- such as its type and value of its elements.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.ConnectionControl.Visit(Apache.NMS.ActiveMQ.State.ICommandVisitor)">
-
- <summery>
- Allows a Visitor to visit this command and return a response to the
- command based on the command type being visited. The command will call
- the proper processXXX method in the visitor.
- </summery>
-
- </member>
- <member name="P:Apache.NMS.ActiveMQ.Commands.ConnectionControl.IsConnectionControl">
-
- <summery>
- Return an answer of true to the isConnectionControl() query.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.ConnectionError.GetDataStructureType">
-
- <summery>
- Get the unique identifier that this object and its own
- Marshaler share.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.ConnectionError.ToString">
-
- <summery>
- Returns a string containing the information for this DataStructure
- such as its type and value of its elements.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.ConnectionError.Visit(Apache.NMS.ActiveMQ.State.ICommandVisitor)">
-
- <summery>
- Allows a Visitor to visit this command and return a response to the
- command based on the command type being visited. The command will call
- the proper processXXX method in the visitor.
- </summery>
-
- </member>
- <member name="P:Apache.NMS.ActiveMQ.Commands.ConnectionError.IsConnectionError">
-
- <summery>
- Return an answer of true to the isConnectionError() query.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.ConnectionId.GetDataStructureType">
-
- <summery>
- Get the unique identifier that this object and its own
- Marshaler share.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.ConnectionId.ToString">
-
- <summery>
- Returns a string containing the information for this DataStructure
- such as its type and value of its elements.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.ConnectionInfo.GetDataStructureType">
-
- <summery>
- Get the unique identifier that this object and its own
- Marshaler share.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.ConnectionInfo.ToString">
-
- <summery>
- Returns a string containing the information for this DataStructure
- such as its type and value of its elements.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.ConnectionInfo.Visit(Apache.NMS.ActiveMQ.State.ICommandVisitor)">
-
- <summery>
- Allows a Visitor to visit this command and return a response to the
- command based on the command type being visited. The command will call
- the proper processXXX method in the visitor.
- </summery>
-
- </member>
- <member name="P:Apache.NMS.ActiveMQ.Commands.ConnectionInfo.IsConnectionInfo">
-
- <summery>
- Return an answer of true to the isConnectionInfo() query.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.ConsumerControl.GetDataStructureType">
-
- <summery>
- Get the unique identifier that this object and its own
- Marshaler share.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.ConsumerControl.ToString">
-
- <summery>
- Returns a string containing the information for this DataStructure
- such as its type and value of its elements.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.ConsumerControl.Visit(Apache.NMS.ActiveMQ.State.ICommandVisitor)">
-
- <summery>
- Allows a Visitor to visit this command and return a response to the
- command based on the command type being visited. The command will call
- the proper processXXX method in the visitor.
- </summery>
-
- </member>
- <member name="P:Apache.NMS.ActiveMQ.Commands.ConsumerControl.IsConsumerControl">
-
- <summery>
- Return an answer of true to the isConsumerControl() query.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.ConsumerId.GetDataStructureType">
-
- <summery>
- Get the unique identifier that this object and its own
- Marshaler share.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.ConsumerId.ToString">
-
- <summery>
- Returns a string containing the information for this DataStructure
- such as its type and value of its elements.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.ConsumerInfo.GetDataStructureType">
-
- <summery>
- Get the unique identifier that this object and its own
- Marshaler share.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.ConsumerInfo.ToString">
-
- <summery>
- Returns a string containing the information for this DataStructure
- such as its type and value of its elements.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.ConsumerInfo.Visit(Apache.NMS.ActiveMQ.State.ICommandVisitor)">
-
- <summery>
- Allows a Visitor to visit this command and return a response to the
- command based on the command type being visited. The command will call
- the proper processXXX method in the visitor.
- </summery>
-
- </member>
- <member name="P:Apache.NMS.ActiveMQ.Commands.ConsumerInfo.IsConsumerInfo">
-
- <summery>
- Return an answer of true to the isConsumerInfo() query.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.ControlCommand.GetDataStructureType">
-
- <summery>
- Get the unique identifier that this object and its own
- Marshaler share.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.ControlCommand.ToString">
-
- <summery>
- Returns a string containing the information for this DataStructure
- such as its type and value of its elements.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.ControlCommand.Visit(Apache.NMS.ActiveMQ.State.ICommandVisitor)">
-
- <summery>
- Allows a Visitor to visit this command and return a response to the
- command based on the command type being visited. The command will call
- the proper processXXX method in the visitor.
- </summery>
-
- </member>
- <member name="P:Apache.NMS.ActiveMQ.Commands.ControlCommand.IsControlCommand">
-
- <summery>
- Return an answer of true to the isControlCommand() query.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.Response.GetDataStructureType">
-
- <summery>
- Get the unique identifier that this object and its own
- Marshaler share.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.Response.ToString">
-
- <summery>
- Returns a string containing the information for this DataStructure
- such as its type and value of its elements.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.Response.Visit(Apache.NMS.ActiveMQ.State.ICommandVisitor)">
-
- <summery>
- Allows a Visitor to visit this command and return a response to the
- command based on the command type being visited. The command will call
- the proper processXXX method in the visitor.
- </summery>
-
- </member>
- <member name="P:Apache.NMS.ActiveMQ.Commands.Response.IsResponse">
-
- <summery>
- Return an answer of true to the isResponse() query.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.DataArrayResponse.GetDataStructureType">
-
- <summery>
- Get the unique identifier that this object and its own
- Marshaler share.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.DataArrayResponse.ToString">
-
- <summery>
- Returns a string containing the information for this DataStructure
- such as its type and value of its elements.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.DataResponse.GetDataStructureType">
-
- <summery>
- Get the unique identifier that this object and its own
- Marshaler share.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.DataResponse.ToString">
-
- <summery>
- Returns a string containing the information for this DataStructure
- such as its type and value of its elements.
- </summery>
-
- </member>
- <member name="T:Apache.NMS.ActiveMQ.Commands.DataStructureSupport">
- <summary>
- Summary description for DataStructureSupport.
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.DestinationInfo.GetDataStructureType">
-
- <summery>
- Get the unique identifier that this object and its own
- Marshaler share.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.DestinationInfo.ToString">
-
- <summery>
- Returns a string containing the information for this DataStructure
- such as its type and value of its elements.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.DestinationInfo.Visit(Apache.NMS.ActiveMQ.State.ICommandVisitor)">
-
- <summery>
- Allows a Visitor to visit this command and return a response to the
- command based on the command type being visited. The command will call
- the proper processXXX method in the visitor.
- </summery>
-
- </member>
- <member name="P:Apache.NMS.ActiveMQ.Commands.DestinationInfo.IsDestinationInfo">
-
- <summery>
- Return an answer of true to the isDestinationInfo() query.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.DiscoveryEvent.GetDataStructureType">
-
- <summery>
- Get the unique identifier that this object and its own
- Marshaler share.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.DiscoveryEvent.ToString">
-
- <summery>
- Returns a string containing the information for this DataStructure
- such as its type and value of its elements.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.ExceptionResponse.GetDataStructureType">
-
- <summery>
- Get the unique identifier that this object and its own
- Marshaler share.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.ExceptionResponse.ToString">
-
- <summery>
- Returns a string containing the information for this DataStructure
- such as its type and value of its elements.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.FlushCommand.GetDataStructureType">
-
- <summery>
- Get the unique identifier that this object and its own
- Marshaler share.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.FlushCommand.ToString">
-
- <summery>
- Returns a string containing the information for this DataStructure
- such as its type and value of its elements.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.FlushCommand.Visit(Apache.NMS.ActiveMQ.State.ICommandVisitor)">
-
- <summery>
- Allows a Visitor to visit this command and return a response to the
- command based on the command type being visited. The command will call
- the proper processXXX method in the visitor.
- </summery>
-
- </member>
- <member name="P:Apache.NMS.ActiveMQ.Commands.FlushCommand.IsFlushCommand">
-
- <summery>
- Return an answer of true to the isFlushCommand() query.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.IntegerResponse.GetDataStructureType">
-
- <summery>
- Get the unique identifier that this object and its own
- Marshaler share.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.IntegerResponse.ToString">
-
- <summery>
- Returns a string containing the information for this DataStructure
- such as its type and value of its elements.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.JournalQueueAck.GetDataStructureType">
-
- <summery>
- Get the unique identifier that this object and its own
- Marshaler share.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.JournalQueueAck.ToString">
-
- <summery>
- Returns a string containing the information for this DataStructure
- such as its type and value of its elements.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.JournalTopicAck.GetDataStructureType">
-
- <summery>
- Get the unique identifier that this object and its own
- Marshaler share.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.JournalTopicAck.ToString">
-
- <summery>
- Returns a string containing the information for this DataStructure
- such as its type and value of its elements.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.JournalTrace.GetDataStructureType">
-
- <summery>
- Get the unique identifier that this object and its own
- Marshaler share.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.JournalTrace.ToString">
-
- <summery>
- Returns a string containing the information for this DataStructure
- such as its type and value of its elements.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.JournalTransaction.GetDataStructureType">
-
- <summery>
- Get the unique identifier that this object and its own
- Marshaler share.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.JournalTransaction.ToString">
-
- <summery>
- Returns a string containing the information for this DataStructure
- such as its type and value of its elements.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.KeepAliveInfo.GetDataStructureType">
-
- <summery>
- Get the unique identifier that this object and its own
- Marshaler share.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.KeepAliveInfo.ToString">
-
- <summery>
- Returns a string containing the information for this DataStructure
- such as its type and value of its elements.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.KeepAliveInfo.Visit(Apache.NMS.ActiveMQ.State.ICommandVisitor)">
-
- <summery>
- Allows a Visitor to visit this command and return a response to the
- command based on the command type being visited. The command will call
- the proper processXXX method in the visitor.
- </summery>
-
- </member>
- <member name="P:Apache.NMS.ActiveMQ.Commands.KeepAliveInfo.IsKeepAliveInfo">
-
- <summery>
- Return an answer of true to the isKeepAliveInfo() query.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.PartialCommand.GetDataStructureType">
-
- <summery>
- Get the unique identifier that this object and its own
- Marshaler share.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.PartialCommand.ToString">
-
- <summery>
- Returns a string containing the information for this DataStructure
- such as its type and value of its elements.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.LastPartialCommand.GetDataStructureType">
-
- <summery>
- Get the unique identifier that this object and its own
- Marshaler share.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.LastPartialCommand.ToString">
-
- <summery>
- Returns a string containing the information for this DataStructure
- such as its type and value of its elements.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.TransactionId.GetDataStructureType">
-
- <summery>
- Get the unique identifier that this object and its own
- Marshaler share.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.TransactionId.ToString">
-
- <summery>
- Returns a string containing the information for this DataStructure
- such as its type and value of its elements.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.LocalTransactionId.GetDataStructureType">
-
- <summery>
- Get the unique identifier that this object and its own
- Marshaler share.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.LocalTransactionId.ToString">
-
- <summery>
- Returns a string containing the information for this DataStructure
- such as its type and value of its elements.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.MessageAck.GetDataStructureType">
-
- <summery>
- Get the unique identifier that this object and its own
- Marshaler share.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.MessageAck.ToString">
-
- <summery>
- Returns a string containing the information for this DataStructure
- such as its type and value of its elements.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.MessageAck.Visit(Apache.NMS.ActiveMQ.State.ICommandVisitor)">
-
- <summery>
- Allows a Visitor to visit this command and return a response to the
- command based on the command type being visited. The command will call
- the proper processXXX method in the visitor.
- </summery>
-
- </member>
- <member name="P:Apache.NMS.ActiveMQ.Commands.MessageAck.IsMessageAck">
-
- <summery>
- Return an answer of true to the isMessageAck() query.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.MessageDispatch.GetDataStructureType">
-
- <summery>
- Get the unique identifier that this object and its own
- Marshaler share.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.MessageDispatch.ToString">
-
- <summery>
- Returns a string containing the information for this DataStructure
- such as its type and value of its elements.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.MessageDispatch.Visit(Apache.NMS.ActiveMQ.State.ICommandVisitor)">
-
- <summery>
- Allows a Visitor to visit this command and return a response to the
- command based on the command type being visited. The command will call
- the proper processXXX method in the visitor.
- </summery>
-
- </member>
- <member name="P:Apache.NMS.ActiveMQ.Commands.MessageDispatch.IsMessageDispatch">
-
- <summery>
- Return an answer of true to the isMessageDispatch() query.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.MessageDispatchNotification.GetDataStructureType">
-
- <summery>
- Get the unique identifier that this object and its own
- Marshaler share.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.MessageDispatchNotification.ToString">
-
- <summery>
- Returns a string containing the information for this DataStructure
- such as its type and value of its elements.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.MessageDispatchNotification.Visit(Apache.NMS.ActiveMQ.State.ICommandVisitor)">
-
- <summery>
- Allows a Visitor to visit this command and return a response to the
- command based on the command type being visited. The command will call
- the proper processXXX method in the visitor.
- </summery>
-
- </member>
- <member name="P:Apache.NMS.ActiveMQ.Commands.MessageDispatchNotification.IsMessageDispatchNotification">
-
- <summery>
- Return an answer of true to the isMessageDispatchNotification() query.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.MessageId.GetDataStructureType">
-
- <summery>
- Get the unique identifier that this object and its own
- Marshaler share.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.MessageId.ToString">
-
- <summery>
- Returns a string containing the information for this DataStructure
- such as its type and value of its elements.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.MessageId.SetValue(System.String)">
- <summary>
- Sets the value as a String
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.MessagePull.GetDataStructureType">
-
- <summery>
- Get the unique identifier that this object and its own
- Marshaler share.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.MessagePull.ToString">
-
- <summery>
- Returns a string containing the information for this DataStructure
- such as its type and value of its elements.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.MessagePull.Visit(Apache.NMS.ActiveMQ.State.ICommandVisitor)">
-
- <summery>
- Allows a Visitor to visit this command and return a response to the
- command based on the command type being visited. The command will call
- the proper processXXX method in the visitor.
- </summery>
-
- </member>
- <member name="P:Apache.NMS.ActiveMQ.Commands.MessagePull.IsMessagePull">
-
- <summery>
- Return an answer of true to the isMessagePull() query.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.NetworkBridgeFilter.GetDataStructureType">
-
- <summery>
- Get the unique identifier that this object and its own
- Marshaler share.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.NetworkBridgeFilter.ToString">
-
- <summery>
- Returns a string containing the information for this DataStructure
- such as its type and value of its elements.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.ProducerAck.GetDataStructureType">
-
- <summery>
- Get the unique identifier that this object and its own
- Marshaler share.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.ProducerAck.ToString">
-
- <summery>
- Returns a string containing the information for this DataStructure
- such as its type and value of its elements.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.ProducerAck.Visit(Apache.NMS.ActiveMQ.State.ICommandVisitor)">
-
- <summery>
- Allows a Visitor to visit this command and return a response to the
- command based on the command type being visited. The command will call
- the proper processXXX method in the visitor.
- </summery>
-
- </member>
- <member name="P:Apache.NMS.ActiveMQ.Commands.ProducerAck.IsProducerAck">
-
- <summery>
- Return an answer of true to the isProducerAck() query.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.ProducerId.GetDataStructureType">
-
- <summery>
- Get the unique identifier that this object and its own
- Marshaler share.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.ProducerId.ToString">
-
- <summery>
- Returns a string containing the information for this DataStructure
- such as its type and value of its elements.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.ProducerInfo.GetDataStructureType">
-
- <summery>
- Get the unique identifier that this object and its own
- Marshaler share.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.ProducerInfo.ToString">
-
- <summery>
- Returns a string containing the information for this DataStructure
- such as its type and value of its elements.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.ProducerInfo.Visit(Apache.NMS.ActiveMQ.State.ICommandVisitor)">
-
- <summery>
- Allows a Visitor to visit this command and return a response to the
- command based on the command type being visited. The command will call
- the proper processXXX method in the visitor.
- </summery>
-
- </member>
- <member name="P:Apache.NMS.ActiveMQ.Commands.ProducerInfo.IsProducerInfo">
-
- <summery>
- Return an answer of true to the isProducerInfo() query.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.RemoveInfo.GetDataStructureType">
-
- <summery>
- Get the unique identifier that this object and its own
- Marshaler share.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.RemoveInfo.ToString">
-
- <summery>
- Returns a string containing the information for this DataStructure
- such as its type and value of its elements.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.RemoveInfo.Visit(Apache.NMS.ActiveMQ.State.ICommandVisitor)">
-
- <summery>
- Allows a Visitor to visit this command and return a response to the
- command based on the command type being visited. The command will call
- the proper processXXX method in the visitor.
- </summery>
-
- </member>
- <member name="P:Apache.NMS.ActiveMQ.Commands.RemoveInfo.IsRemoveInfo">
-
- <summery>
- Return an answer of true to the isRemoveInfo() query.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.RemoveSubscriptionInfo.GetDataStructureType">
-
- <summery>
- Get the unique identifier that this object and its own
- Marshaler share.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.RemoveSubscriptionInfo.ToString">
-
- <summery>
- Returns a string containing the information for this DataStructure
- such as its type and value of its elements.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.RemoveSubscriptionInfo.Visit(Apache.NMS.ActiveMQ.State.ICommandVisitor)">
-
- <summery>
- Allows a Visitor to visit this command and return a response to the
- command based on the command type being visited. The command will call
- the proper processXXX method in the visitor.
- </summery>
-
- </member>
- <member name="P:Apache.NMS.ActiveMQ.Commands.RemoveSubscriptionInfo.IsRemoveSubscriptionInfo">
-
- <summery>
- Return an answer of true to the isRemoveSubscriptionInfo() query.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.ReplayCommand.GetDataStructureType">
-
- <summery>
- Get the unique identifier that this object and its own
- Marshaler share.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.ReplayCommand.ToString">
-
- <summery>
- Returns a string containing the information for this DataStructure
- such as its type and value of its elements.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.ReplayCommand.Visit(Apache.NMS.ActiveMQ.State.ICommandVisitor)">
-
- <summery>
- Allows a Visitor to visit this command and return a response to the
- command based on the command type being visited. The command will call
- the proper processXXX method in the visitor.
- </summery>
-
- </member>
- <member name="P:Apache.NMS.ActiveMQ.Commands.ReplayCommand.IsReplayCommand">
-
- <summery>
- Return an answer of true to the isReplayCommand() query.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.SessionId.GetDataStructureType">
-
- <summery>
- Get the unique identifier that this object and its own
- Marshaler share.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.SessionId.ToString">
-
- <summery>
- Returns a string containing the information for this DataStructure
- such as its type and value of its elements.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.SessionInfo.GetDataStructureType">
-
- <summery>
- Get the unique identifier that this object and its own
- Marshaler share.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.SessionInfo.ToString">
-
- <summery>
- Returns a string containing the information for this DataStructure
- such as its type and value of its elements.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.SessionInfo.Visit(Apache.NMS.ActiveMQ.State.ICommandVisitor)">
-
- <summery>
- Allows a Visitor to visit this command and return a response to the
- command based on the command type being visited. The command will call
- the proper processXXX method in the visitor.
- </summery>
-
- </member>
- <member name="P:Apache.NMS.ActiveMQ.Commands.SessionInfo.IsSessionInfo">
-
- <summery>
- Return an answer of true to the isSessionInfo() query.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.ShutdownInfo.GetDataStructureType">
-
- <summery>
- Get the unique identifier that this object and its own
- Marshaler share.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.ShutdownInfo.ToString">
-
- <summery>
- Returns a string containing the information for this DataStructure
- such as its type and value of its elements.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.ShutdownInfo.Visit(Apache.NMS.ActiveMQ.State.ICommandVisitor)">
-
- <summery>
- Allows a Visitor to visit this command and return a response to the
- command based on the command type being visited. The command will call
- the proper processXXX method in the visitor.
- </summery>
-
- </member>
- <member name="P:Apache.NMS.ActiveMQ.Commands.ShutdownInfo.IsShutdownInfo">
-
- <summery>
- Return an answer of true to the isShutdownInfo() query.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.SubscriptionInfo.GetDataStructureType">
-
- <summery>
- Get the unique identifier that this object and its own
- Marshaler share.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.SubscriptionInfo.ToString">
-
- <summery>
- Returns a string containing the information for this DataStructure
- such as its type and value of its elements.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.TransactionInfo.GetDataStructureType">
-
- <summery>
- Get the unique identifier that this object and its own
- Marshaler share.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.TransactionInfo.ToString">
-
- <summery>
- Returns a string containing the information for this DataStructure
- such as its type and value of its elements.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.TransactionInfo.Visit(Apache.NMS.ActiveMQ.State.ICommandVisitor)">
-
- <summery>
- Allows a Visitor to visit this command and return a response to the
- command based on the command type being visited. The command will call
- the proper processXXX method in the visitor.
- </summery>
-
- </member>
- <member name="P:Apache.NMS.ActiveMQ.Commands.TransactionInfo.IsTransactionInfo">
-
- <summery>
- Return an answer of true to the isTransactionInfo() query.
- </summery>
-
- </member>
- <member name="P:Apache.NMS.ActiveMQ.Commands.WireFormatInfo.IsWireFormatInfo">
-
- <summery>
- Return an answer of true to the IsWireFormatInfo() query.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.XATransactionId.GetDataStructureType">
-
- <summery>
- Get the unique identifier that this object and its own
- Marshaler share.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Commands.XATransactionId.ToString">
-
- <summery>
- Returns a string containing the information for this DataStructure
- such as its type and value of its elements.
- </summery>
-
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V1.ActiveMQBlobMessageMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ActiveMQBlobMessage
- </summary>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V1.ActiveMQMessageMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ActiveMQMessage
- </summary>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V1.MessageMarshaller">
- <summary>
- Marshalling code for Open Wire Format for Message
- </summary>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V1.BaseCommandMarshaller">
- <summary>
- Marshalling code for Open Wire Format for BaseCommand
- </summary>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.BaseDataStreamMarshaller">
- <summary>
- A base class with useful implementation inheritence methods
- for creating marshallers of the OpenWire protocol
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.BaseDataStreamMarshaller.ToString(Apache.NMS.ActiveMQ.Commands.MessageId)">
- <summary>
- Converts the object to a String
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.BaseDataStreamMarshaller.ToString(Apache.NMS.ActiveMQ.Commands.ProducerId)">
- <summary>
- Converts the object to a String
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.BaseDataStreamMarshaller.ToString(Apache.NMS.ActiveMQ.Commands.TransactionId)">
- <summary>
- Converts the given transaction ID into a String
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.BaseDataStreamMarshaller.ToHexFromBytes(System.Byte[])">
- <summary>
- Creates the byte array into hexidecimal
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V1.ActiveMQMessageMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V1.ActiveMQMessageMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V1.ActiveMQBlobMessageMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V1.ActiveMQBlobMessageMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V1.ActiveMQBytesMessageMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ActiveMQBytesMessage
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V1.ActiveMQBytesMessageMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V1.ActiveMQBytesMessageMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V1.ActiveMQDestinationMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ActiveMQDestination
- </summary>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V1.ActiveMQMapMessageMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ActiveMQMapMessage
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V1.ActiveMQMapMessageMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V1.ActiveMQMapMessageMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V1.ActiveMQObjectMessageMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ActiveMQObjectMessage
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V1.ActiveMQObjectMessageMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V1.ActiveMQObjectMessageMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V1.ActiveMQQueueMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ActiveMQQueue
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V1.ActiveMQQueueMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V1.ActiveMQQueueMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V1.ActiveMQStreamMessageMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ActiveMQStreamMessage
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V1.ActiveMQStreamMessageMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V1.ActiveMQStreamMessageMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V1.ActiveMQTempDestinationMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ActiveMQTempDestination
- </summary>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V1.ActiveMQTempQueueMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ActiveMQTempQueue
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V1.ActiveMQTempQueueMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V1.ActiveMQTempQueueMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V1.ActiveMQTempTopicMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ActiveMQTempTopic
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V1.ActiveMQTempTopicMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V1.ActiveMQTempTopicMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V1.ActiveMQTextMessageMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ActiveMQTextMessage
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V1.ActiveMQTextMessageMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V1.ActiveMQTextMessageMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V1.ActiveMQTopicMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ActiveMQTopic
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V1.ActiveMQTopicMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V1.ActiveMQTopicMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V1.BrokerIdMarshaller">
- <summary>
- Marshalling code for Open Wire Format for BrokerId
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V1.BrokerIdMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V1.BrokerIdMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V1.BrokerInfoMarshaller">
- <summary>
- Marshalling code for Open Wire Format for BrokerInfo
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V1.BrokerInfoMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V1.BrokerInfoMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V1.ConnectionControlMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ConnectionControl
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V1.ConnectionControlMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V1.ConnectionControlMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V1.ConnectionErrorMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ConnectionError
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V1.ConnectionErrorMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V1.ConnectionErrorMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V1.ConnectionIdMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ConnectionId
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V1.ConnectionIdMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V1.ConnectionIdMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V1.ConnectionInfoMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ConnectionInfo
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V1.ConnectionInfoMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V1.ConnectionInfoMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V1.ConsumerControlMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ConsumerControl
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V1.ConsumerControlMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V1.ConsumerControlMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V1.ConsumerIdMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ConsumerId
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V1.ConsumerIdMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V1.ConsumerIdMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V1.ConsumerInfoMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ConsumerInfo
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V1.ConsumerInfoMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V1.ConsumerInfoMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V1.ControlCommandMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ControlCommand
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V1.ControlCommandMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V1.ControlCommandMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V1.DataArrayResponseMarshaller">
- <summary>
- Marshalling code for Open Wire Format for DataArrayResponse
- </summary>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V1.ResponseMarshaller">
- <summary>
- Marshalling code for Open Wire Format for Response
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V1.ResponseMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V1.ResponseMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V1.DataArrayResponseMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V1.DataArrayResponseMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V1.DataResponseMarshaller">
- <summary>
- Marshalling code for Open Wire Format for DataResponse
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V1.DataResponseMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V1.DataResponseMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V1.DestinationInfoMarshaller">
- <summary>
- Marshalling code for Open Wire Format for DestinationInfo
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V1.DestinationInfoMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V1.DestinationInfoMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V1.DiscoveryEventMarshaller">
- <summary>
- Marshalling code for Open Wire Format for DiscoveryEvent
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V1.DiscoveryEventMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V1.DiscoveryEventMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V1.ExceptionResponseMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ExceptionResponse
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V1.ExceptionResponseMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V1.ExceptionResponseMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V1.FlushCommandMarshaller">
- <summary>
- Marshalling code for Open Wire Format for FlushCommand
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V1.FlushCommandMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V1.FlushCommandMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V1.IntegerResponseMarshaller">
- <summary>
- Marshalling code for Open Wire Format for IntegerResponse
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V1.IntegerResponseMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V1.IntegerResponseMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V1.JournalQueueAckMarshaller">
- <summary>
- Marshalling code for Open Wire Format for JournalQueueAck
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V1.JournalQueueAckMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V1.JournalQueueAckMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V1.JournalTopicAckMarshaller">
- <summary>
- Marshalling code for Open Wire Format for JournalTopicAck
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V1.JournalTopicAckMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V1.JournalTopicAckMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V1.JournalTraceMarshaller">
- <summary>
- Marshalling code for Open Wire Format for JournalTrace
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V1.JournalTraceMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V1.JournalTraceMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V1.JournalTransactionMarshaller">
- <summary>
- Marshalling code for Open Wire Format for JournalTransaction
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V1.JournalTransactionMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V1.JournalTransactionMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V1.KeepAliveInfoMarshaller">
- <summary>
- Marshalling code for Open Wire Format for KeepAliveInfo
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V1.KeepAliveInfoMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V1.KeepAliveInfoMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V1.LastPartialCommandMarshaller">
- <summary>
- Marshalling code for Open Wire Format for LastPartialCommand
- </summary>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V1.PartialCommandMarshaller">
- <summary>
- Marshalling code for Open Wire Format for PartialCommand
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V1.PartialCommandMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V1.PartialCommandMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V1.LastPartialCommandMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V1.LastPartialCommandMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V1.LocalTransactionIdMarshaller">
- <summary>
- Marshalling code for Open Wire Format for LocalTransactionId
- </summary>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V1.TransactionIdMarshaller">
- <summary>
- Marshalling code for Open Wire Format for TransactionId
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V1.LocalTransactionIdMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V1.LocalTransactionIdMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V1.MarshallerFactory">
- <summary>
- Used to create marshallers for a specific version of the OpenWire protocol.
- Each non-abstract DataStructure object has a registered Marshaller that is
- created and added to the OpenWireFormat objects format collection.
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V1.MarshallerFactory.configure(Apache.NMS.ActiveMQ.OpenWire.OpenWireFormat)">
- <summery>
- Adds the Marshallers for this version of the OpenWire protocol to the
- Collection of Marshallers stored in the OpenWireFormat class.
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V1.MessageAckMarshaller">
- <summary>
- Marshalling code for Open Wire Format for MessageAck
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V1.MessageAckMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V1.MessageAckMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V1.MessageDispatchMarshaller">
- <summary>
- Marshalling code for Open Wire Format for MessageDispatch
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V1.MessageDispatchMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V1.MessageDispatchMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V1.MessageDispatchNotificationMarshaller">
- <summary>
- Marshalling code for Open Wire Format for MessageDispatchNotification
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V1.MessageDispatchNotificationMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V1.MessageDispatchNotificationMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V1.MessageIdMarshaller">
- <summary>
- Marshalling code for Open Wire Format for MessageId
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V1.MessageIdMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V1.MessageIdMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V1.MessagePullMarshaller">
- <summary>
- Marshalling code for Open Wire Format for MessagePull
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V1.MessagePullMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V1.MessagePullMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V1.NetworkBridgeFilterMarshaller">
- <summary>
- Marshalling code for Open Wire Format for NetworkBridgeFilter
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V1.NetworkBridgeFilterMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V1.NetworkBridgeFilterMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V1.ProducerAckMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ProducerAck
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V1.ProducerAckMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V1.ProducerAckMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V1.ProducerIdMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ProducerId
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V1.ProducerIdMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V1.ProducerIdMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V1.ProducerInfoMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ProducerInfo
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V1.ProducerInfoMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V1.ProducerInfoMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V1.RemoveInfoMarshaller">
- <summary>
- Marshalling code for Open Wire Format for RemoveInfo
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V1.RemoveInfoMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V1.RemoveInfoMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V1.RemoveSubscriptionInfoMarshaller">
- <summary>
- Marshalling code for Open Wire Format for RemoveSubscriptionInfo
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V1.RemoveSubscriptionInfoMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V1.RemoveSubscriptionInfoMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V1.ReplayCommandMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ReplayCommand
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V1.ReplayCommandMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V1.ReplayCommandMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V1.SessionIdMarshaller">
- <summary>
- Marshalling code for Open Wire Format for SessionId
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V1.SessionIdMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V1.SessionIdMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V1.SessionInfoMarshaller">
- <summary>
- Marshalling code for Open Wire Format for SessionInfo
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V1.SessionInfoMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V1.SessionInfoMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V1.ShutdownInfoMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ShutdownInfo
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V1.ShutdownInfoMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V1.ShutdownInfoMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V1.SubscriptionInfoMarshaller">
- <summary>
- Marshalling code for Open Wire Format for SubscriptionInfo
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V1.SubscriptionInfoMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V1.SubscriptionInfoMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V1.TransactionInfoMarshaller">
- <summary>
- Marshalling code for Open Wire Format for TransactionInfo
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V1.TransactionInfoMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V1.TransactionInfoMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V1.WireFormatInfoMarshaller">
- <summary>
- Marshalling code for Open Wire Format for WireFormatInfo
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V1.WireFormatInfoMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V1.WireFormatInfoMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V1.XATransactionIdMarshaller">
- <summary>
- Marshalling code for Open Wire Format for XATransactionId
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V1.XATransactionIdMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V1.XATransactionIdMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V10.ActiveMQBlobMessageMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ActiveMQBlobMessage
- </summary>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V10.ActiveMQMessageMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ActiveMQMessage
- </summary>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V10.MessageMarshaller">
- <summary>
- Marshalling code for Open Wire Format for Message
- </summary>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V10.BaseCommandMarshaller">
- <summary>
- Marshalling code for Open Wire Format for BaseCommand
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V10.ActiveMQMessageMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V10.ActiveMQMessageMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V10.ActiveMQBlobMessageMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V10.ActiveMQBlobMessageMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V10.ActiveMQBytesMessageMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ActiveMQBytesMessage
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V10.ActiveMQBytesMessageMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V10.ActiveMQBytesMessageMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V10.ActiveMQDestinationMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ActiveMQDestination
- </summary>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V10.ActiveMQMapMessageMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ActiveMQMapMessage
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V10.ActiveMQMapMessageMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V10.ActiveMQMapMessageMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V10.ActiveMQObjectMessageMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ActiveMQObjectMessage
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V10.ActiveMQObjectMessageMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V10.ActiveMQObjectMessageMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V10.ActiveMQQueueMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ActiveMQQueue
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V10.ActiveMQQueueMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V10.ActiveMQQueueMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V10.ActiveMQStreamMessageMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ActiveMQStreamMessage
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V10.ActiveMQStreamMessageMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V10.ActiveMQStreamMessageMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V10.ActiveMQTempDestinationMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ActiveMQTempDestination
- </summary>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V10.ActiveMQTempQueueMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ActiveMQTempQueue
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V10.ActiveMQTempQueueMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V10.ActiveMQTempQueueMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V10.ActiveMQTempTopicMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ActiveMQTempTopic
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V10.ActiveMQTempTopicMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V10.ActiveMQTempTopicMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V10.ActiveMQTextMessageMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ActiveMQTextMessage
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V10.ActiveMQTextMessageMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V10.ActiveMQTextMessageMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V10.ActiveMQTopicMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ActiveMQTopic
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V10.ActiveMQTopicMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V10.ActiveMQTopicMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V10.BrokerIdMarshaller">
- <summary>
- Marshalling code for Open Wire Format for BrokerId
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V10.BrokerIdMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V10.BrokerIdMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V10.BrokerInfoMarshaller">
- <summary>
- Marshalling code for Open Wire Format for BrokerInfo
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V10.BrokerInfoMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V10.BrokerInfoMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V10.ConnectionControlMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ConnectionControl
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V10.ConnectionControlMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V10.ConnectionControlMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V10.ConnectionErrorMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ConnectionError
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V10.ConnectionErrorMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V10.ConnectionErrorMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V10.ConnectionIdMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ConnectionId
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V10.ConnectionIdMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V10.ConnectionIdMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V10.ConnectionInfoMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ConnectionInfo
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V10.ConnectionInfoMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V10.ConnectionInfoMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V10.ConsumerControlMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ConsumerControl
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V10.ConsumerControlMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V10.ConsumerControlMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V10.ConsumerIdMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ConsumerId
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V10.ConsumerIdMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V10.ConsumerIdMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V10.ConsumerInfoMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ConsumerInfo
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V10.ConsumerInfoMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V10.ConsumerInfoMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V10.ControlCommandMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ControlCommand
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V10.ControlCommandMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V10.ControlCommandMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V10.DataArrayResponseMarshaller">
- <summary>
- Marshalling code for Open Wire Format for DataArrayResponse
- </summary>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V10.ResponseMarshaller">
- <summary>
- Marshalling code for Open Wire Format for Response
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V10.ResponseMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V10.ResponseMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V10.DataArrayResponseMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V10.DataArrayResponseMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V10.DataResponseMarshaller">
- <summary>
- Marshalling code for Open Wire Format for DataResponse
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V10.DataResponseMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V10.DataResponseMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V10.DestinationInfoMarshaller">
- <summary>
- Marshalling code for Open Wire Format for DestinationInfo
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V10.DestinationInfoMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V10.DestinationInfoMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V10.DiscoveryEventMarshaller">
- <summary>
- Marshalling code for Open Wire Format for DiscoveryEvent
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V10.DiscoveryEventMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V10.DiscoveryEventMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V10.ExceptionResponseMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ExceptionResponse
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V10.ExceptionResponseMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V10.ExceptionResponseMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V10.FlushCommandMarshaller">
- <summary>
- Marshalling code for Open Wire Format for FlushCommand
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V10.FlushCommandMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V10.FlushCommandMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V10.IntegerResponseMarshaller">
- <summary>
- Marshalling code for Open Wire Format for IntegerResponse
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V10.IntegerResponseMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V10.IntegerResponseMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V10.JournalQueueAckMarshaller">
- <summary>
- Marshalling code for Open Wire Format for JournalQueueAck
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V10.JournalQueueAckMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V10.JournalQueueAckMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V10.JournalTopicAckMarshaller">
- <summary>
- Marshalling code for Open Wire Format for JournalTopicAck
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V10.JournalTopicAckMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V10.JournalTopicAckMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V10.JournalTraceMarshaller">
- <summary>
- Marshalling code for Open Wire Format for JournalTrace
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V10.JournalTraceMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V10.JournalTraceMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V10.JournalTransactionMarshaller">
- <summary>
- Marshalling code for Open Wire Format for JournalTransaction
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V10.JournalTransactionMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V10.JournalTransactionMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V10.KeepAliveInfoMarshaller">
- <summary>
- Marshalling code for Open Wire Format for KeepAliveInfo
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V10.KeepAliveInfoMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V10.KeepAliveInfoMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V10.LastPartialCommandMarshaller">
- <summary>
- Marshalling code for Open Wire Format for LastPartialCommand
- </summary>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V10.PartialCommandMarshaller">
- <summary>
- Marshalling code for Open Wire Format for PartialCommand
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V10.PartialCommandMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V10.PartialCommandMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V10.LastPartialCommandMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V10.LastPartialCommandMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V10.LocalTransactionIdMarshaller">
- <summary>
- Marshalling code for Open Wire Format for LocalTransactionId
- </summary>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V10.TransactionIdMarshaller">
- <summary>
- Marshalling code for Open Wire Format for TransactionId
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V10.LocalTransactionIdMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V10.LocalTransactionIdMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V10.MarshallerFactory">
- <summary>
- Used to create marshallers for a specific version of the OpenWire protocol.
- Each non-abstract DataStructure object has a registered Marshaller that is
- created and added to the OpenWireFormat objects format collection.
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V10.MarshallerFactory.configure(Apache.NMS.ActiveMQ.OpenWire.OpenWireFormat)">
- <summery>
- Adds the Marshallers for this version of the OpenWire protocol to the
- Collection of Marshallers stored in the OpenWireFormat class.
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V10.MessageAckMarshaller">
- <summary>
- Marshalling code for Open Wire Format for MessageAck
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V10.MessageAckMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V10.MessageAckMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V10.MessageDispatchMarshaller">
- <summary>
- Marshalling code for Open Wire Format for MessageDispatch
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V10.MessageDispatchMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V10.MessageDispatchMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V10.MessageDispatchNotificationMarshaller">
- <summary>
- Marshalling code for Open Wire Format for MessageDispatchNotification
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V10.MessageDispatchNotificationMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V10.MessageDispatchNotificationMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V10.MessageIdMarshaller">
- <summary>
- Marshalling code for Open Wire Format for MessageId
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V10.MessageIdMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V10.MessageIdMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V10.MessagePullMarshaller">
- <summary>
- Marshalling code for Open Wire Format for MessagePull
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V10.MessagePullMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V10.MessagePullMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V10.NetworkBridgeFilterMarshaller">
- <summary>
- Marshalling code for Open Wire Format for NetworkBridgeFilter
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V10.NetworkBridgeFilterMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V10.NetworkBridgeFilterMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V10.ProducerAckMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ProducerAck
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V10.ProducerAckMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V10.ProducerAckMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V10.ProducerIdMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ProducerId
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V10.ProducerIdMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V10.ProducerIdMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V10.ProducerInfoMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ProducerInfo
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V10.ProducerInfoMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V10.ProducerInfoMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V10.RemoveInfoMarshaller">
- <summary>
- Marshalling code for Open Wire Format for RemoveInfo
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V10.RemoveInfoMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V10.RemoveInfoMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V10.RemoveSubscriptionInfoMarshaller">
- <summary>
- Marshalling code for Open Wire Format for RemoveSubscriptionInfo
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V10.RemoveSubscriptionInfoMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V10.RemoveSubscriptionInfoMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V10.ReplayCommandMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ReplayCommand
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V10.ReplayCommandMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V10.ReplayCommandMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V10.SessionIdMarshaller">
- <summary>
- Marshalling code for Open Wire Format for SessionId
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V10.SessionIdMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V10.SessionIdMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V10.SessionInfoMarshaller">
- <summary>
- Marshalling code for Open Wire Format for SessionInfo
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V10.SessionInfoMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V10.SessionInfoMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V10.ShutdownInfoMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ShutdownInfo
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V10.ShutdownInfoMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V10.ShutdownInfoMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V10.SubscriptionInfoMarshaller">
- <summary>
- Marshalling code for Open Wire Format for SubscriptionInfo
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V10.SubscriptionInfoMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V10.SubscriptionInfoMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V10.TransactionInfoMarshaller">
- <summary>
- Marshalling code for Open Wire Format for TransactionInfo
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V10.TransactionInfoMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V10.TransactionInfoMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V10.WireFormatInfoMarshaller">
- <summary>
- Marshalling code for Open Wire Format for WireFormatInfo
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V10.WireFormatInfoMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V10.WireFormatInfoMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V10.XATransactionIdMarshaller">
- <summary>
- Marshalling code for Open Wire Format for XATransactionId
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V10.XATransactionIdMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V10.XATransactionIdMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V2.ActiveMQBlobMessageMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ActiveMQBlobMessage
- </summary>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V2.ActiveMQMessageMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ActiveMQMessage
- </summary>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V2.MessageMarshaller">
- <summary>
- Marshalling code for Open Wire Format for Message
- </summary>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V2.BaseCommandMarshaller">
- <summary>
- Marshalling code for Open Wire Format for BaseCommand
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V2.ActiveMQMessageMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V2.ActiveMQMessageMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V2.ActiveMQBlobMessageMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V2.ActiveMQBlobMessageMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V2.ActiveMQBytesMessageMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ActiveMQBytesMessage
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V2.ActiveMQBytesMessageMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V2.ActiveMQBytesMessageMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V2.ActiveMQDestinationMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ActiveMQDestination
- </summary>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V2.ActiveMQMapMessageMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ActiveMQMapMessage
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V2.ActiveMQMapMessageMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V2.ActiveMQMapMessageMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V2.ActiveMQObjectMessageMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ActiveMQObjectMessage
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V2.ActiveMQObjectMessageMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V2.ActiveMQObjectMessageMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V2.ActiveMQQueueMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ActiveMQQueue
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V2.ActiveMQQueueMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V2.ActiveMQQueueMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V2.ActiveMQStreamMessageMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ActiveMQStreamMessage
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V2.ActiveMQStreamMessageMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V2.ActiveMQStreamMessageMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V2.ActiveMQTempDestinationMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ActiveMQTempDestination
- </summary>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V2.ActiveMQTempQueueMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ActiveMQTempQueue
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V2.ActiveMQTempQueueMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V2.ActiveMQTempQueueMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V2.ActiveMQTempTopicMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ActiveMQTempTopic
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V2.ActiveMQTempTopicMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V2.ActiveMQTempTopicMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V2.ActiveMQTextMessageMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ActiveMQTextMessage
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V2.ActiveMQTextMessageMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V2.ActiveMQTextMessageMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V2.ActiveMQTopicMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ActiveMQTopic
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V2.ActiveMQTopicMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V2.ActiveMQTopicMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V2.BrokerIdMarshaller">
- <summary>
- Marshalling code for Open Wire Format for BrokerId
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V2.BrokerIdMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V2.BrokerIdMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V2.BrokerInfoMarshaller">
- <summary>
- Marshalling code for Open Wire Format for BrokerInfo
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V2.BrokerInfoMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V2.BrokerInfoMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V2.ConnectionControlMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ConnectionControl
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V2.ConnectionControlMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V2.ConnectionControlMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V2.ConnectionErrorMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ConnectionError
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V2.ConnectionErrorMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V2.ConnectionErrorMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V2.ConnectionIdMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ConnectionId
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V2.ConnectionIdMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V2.ConnectionIdMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V2.ConnectionInfoMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ConnectionInfo
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V2.ConnectionInfoMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V2.ConnectionInfoMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V2.ConsumerControlMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ConsumerControl
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V2.ConsumerControlMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V2.ConsumerControlMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V2.ConsumerIdMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ConsumerId
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V2.ConsumerIdMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V2.ConsumerIdMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V2.ConsumerInfoMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ConsumerInfo
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V2.ConsumerInfoMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V2.ConsumerInfoMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V2.ControlCommandMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ControlCommand
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V2.ControlCommandMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V2.ControlCommandMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V2.DataArrayResponseMarshaller">
- <summary>
- Marshalling code for Open Wire Format for DataArrayResponse
- </summary>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V2.ResponseMarshaller">
- <summary>
- Marshalling code for Open Wire Format for Response
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V2.ResponseMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V2.ResponseMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V2.DataArrayResponseMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V2.DataArrayResponseMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V2.DataResponseMarshaller">
- <summary>
- Marshalling code for Open Wire Format for DataResponse
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V2.DataResponseMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V2.DataResponseMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V2.DestinationInfoMarshaller">
- <summary>
- Marshalling code for Open Wire Format for DestinationInfo
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V2.DestinationInfoMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V2.DestinationInfoMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V2.DiscoveryEventMarshaller">
- <summary>
- Marshalling code for Open Wire Format for DiscoveryEvent
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V2.DiscoveryEventMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V2.DiscoveryEventMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V2.ExceptionResponseMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ExceptionResponse
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V2.ExceptionResponseMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V2.ExceptionResponseMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V2.FlushCommandMarshaller">
- <summary>
- Marshalling code for Open Wire Format for FlushCommand
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V2.FlushCommandMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V2.FlushCommandMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V2.IntegerResponseMarshaller">
- <summary>
- Marshalling code for Open Wire Format for IntegerResponse
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V2.IntegerResponseMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V2.IntegerResponseMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V2.JournalQueueAckMarshaller">
- <summary>
- Marshalling code for Open Wire Format for JournalQueueAck
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V2.JournalQueueAckMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V2.JournalQueueAckMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V2.JournalTopicAckMarshaller">
- <summary>
- Marshalling code for Open Wire Format for JournalTopicAck
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V2.JournalTopicAckMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V2.JournalTopicAckMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V2.JournalTraceMarshaller">
- <summary>
- Marshalling code for Open Wire Format for JournalTrace
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V2.JournalTraceMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V2.JournalTraceMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V2.JournalTransactionMarshaller">
- <summary>
- Marshalling code for Open Wire Format for JournalTransaction
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V2.JournalTransactionMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V2.JournalTransactionMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V2.KeepAliveInfoMarshaller">
- <summary>
- Marshalling code for Open Wire Format for KeepAliveInfo
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V2.KeepAliveInfoMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V2.KeepAliveInfoMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V2.LastPartialCommandMarshaller">
- <summary>
- Marshalling code for Open Wire Format for LastPartialCommand
- </summary>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V2.PartialCommandMarshaller">
- <summary>
- Marshalling code for Open Wire Format for PartialCommand
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V2.PartialCommandMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V2.PartialCommandMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V2.LastPartialCommandMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V2.LastPartialCommandMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V2.LocalTransactionIdMarshaller">
- <summary>
- Marshalling code for Open Wire Format for LocalTransactionId
- </summary>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V2.TransactionIdMarshaller">
- <summary>
- Marshalling code for Open Wire Format for TransactionId
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V2.LocalTransactionIdMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V2.LocalTransactionIdMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V2.MarshallerFactory">
- <summary>
- Used to create marshallers for a specific version of the OpenWire protocol.
- Each non-abstract DataStructure object has a registered Marshaller that is
- created and added to the OpenWireFormat objects format collection.
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V2.MarshallerFactory.configure(Apache.NMS.ActiveMQ.OpenWire.OpenWireFormat)">
- <summery>
- Adds the Marshallers for this version of the OpenWire protocol to the
- Collection of Marshallers stored in the OpenWireFormat class.
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V2.MessageAckMarshaller">
- <summary>
- Marshalling code for Open Wire Format for MessageAck
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V2.MessageAckMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V2.MessageAckMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V2.MessageDispatchMarshaller">
- <summary>
- Marshalling code for Open Wire Format for MessageDispatch
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V2.MessageDispatchMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V2.MessageDispatchMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V2.MessageDispatchNotificationMarshaller">
- <summary>
- Marshalling code for Open Wire Format for MessageDispatchNotification
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V2.MessageDispatchNotificationMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V2.MessageDispatchNotificationMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V2.MessageIdMarshaller">
- <summary>
- Marshalling code for Open Wire Format for MessageId
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V2.MessageIdMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V2.MessageIdMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V2.MessagePullMarshaller">
- <summary>
- Marshalling code for Open Wire Format for MessagePull
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V2.MessagePullMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V2.MessagePullMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V2.NetworkBridgeFilterMarshaller">
- <summary>
- Marshalling code for Open Wire Format for NetworkBridgeFilter
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V2.NetworkBridgeFilterMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V2.NetworkBridgeFilterMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V2.ProducerAckMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ProducerAck
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V2.ProducerAckMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V2.ProducerAckMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V2.ProducerIdMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ProducerId
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V2.ProducerIdMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V2.ProducerIdMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V2.ProducerInfoMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ProducerInfo
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V2.ProducerInfoMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V2.ProducerInfoMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V2.RemoveInfoMarshaller">
- <summary>
- Marshalling code for Open Wire Format for RemoveInfo
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V2.RemoveInfoMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V2.RemoveInfoMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V2.RemoveSubscriptionInfoMarshaller">
- <summary>
- Marshalling code for Open Wire Format for RemoveSubscriptionInfo
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V2.RemoveSubscriptionInfoMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V2.RemoveSubscriptionInfoMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V2.ReplayCommandMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ReplayCommand
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V2.ReplayCommandMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V2.ReplayCommandMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V2.SessionIdMarshaller">
- <summary>
- Marshalling code for Open Wire Format for SessionId
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V2.SessionIdMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V2.SessionIdMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V2.SessionInfoMarshaller">
- <summary>
- Marshalling code for Open Wire Format for SessionInfo
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V2.SessionInfoMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V2.SessionInfoMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V2.ShutdownInfoMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ShutdownInfo
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V2.ShutdownInfoMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V2.ShutdownInfoMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V2.SubscriptionInfoMarshaller">
- <summary>
- Marshalling code for Open Wire Format for SubscriptionInfo
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V2.SubscriptionInfoMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V2.SubscriptionInfoMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V2.TransactionInfoMarshaller">
- <summary>
- Marshalling code for Open Wire Format for TransactionInfo
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V2.TransactionInfoMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V2.TransactionInfoMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V2.WireFormatInfoMarshaller">
- <summary>
- Marshalling code for Open Wire Format for WireFormatInfo
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V2.WireFormatInfoMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V2.WireFormatInfoMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V2.XATransactionIdMarshaller">
- <summary>
- Marshalling code for Open Wire Format for XATransactionId
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V2.XATransactionIdMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V2.XATransactionIdMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V3.ActiveMQBlobMessageMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ActiveMQBlobMessage
- </summary>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V3.ActiveMQMessageMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ActiveMQMessage
- </summary>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V3.MessageMarshaller">
- <summary>
- Marshalling code for Open Wire Format for Message
- </summary>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V3.BaseCommandMarshaller">
- <summary>
- Marshalling code for Open Wire Format for BaseCommand
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V3.ActiveMQMessageMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V3.ActiveMQMessageMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V3.ActiveMQBlobMessageMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V3.ActiveMQBlobMessageMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V3.ActiveMQBytesMessageMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ActiveMQBytesMessage
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V3.ActiveMQBytesMessageMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V3.ActiveMQBytesMessageMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V3.ActiveMQDestinationMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ActiveMQDestination
- </summary>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V3.ActiveMQMapMessageMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ActiveMQMapMessage
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V3.ActiveMQMapMessageMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V3.ActiveMQMapMessageMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V3.ActiveMQObjectMessageMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ActiveMQObjectMessage
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V3.ActiveMQObjectMessageMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V3.ActiveMQObjectMessageMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V3.ActiveMQQueueMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ActiveMQQueue
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V3.ActiveMQQueueMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V3.ActiveMQQueueMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V3.ActiveMQStreamMessageMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ActiveMQStreamMessage
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V3.ActiveMQStreamMessageMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V3.ActiveMQStreamMessageMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V3.ActiveMQTempDestinationMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ActiveMQTempDestination
- </summary>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V3.ActiveMQTempQueueMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ActiveMQTempQueue
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V3.ActiveMQTempQueueMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V3.ActiveMQTempQueueMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V3.ActiveMQTempTopicMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ActiveMQTempTopic
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V3.ActiveMQTempTopicMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V3.ActiveMQTempTopicMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V3.ActiveMQTextMessageMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ActiveMQTextMessage
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V3.ActiveMQTextMessageMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V3.ActiveMQTextMessageMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V3.ActiveMQTopicMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ActiveMQTopic
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V3.ActiveMQTopicMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V3.ActiveMQTopicMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V3.BrokerIdMarshaller">
- <summary>
- Marshalling code for Open Wire Format for BrokerId
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V3.BrokerIdMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V3.BrokerIdMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V3.BrokerInfoMarshaller">
- <summary>
- Marshalling code for Open Wire Format for BrokerInfo
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V3.BrokerInfoMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V3.BrokerInfoMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V3.ConnectionControlMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ConnectionControl
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V3.ConnectionControlMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V3.ConnectionControlMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V3.ConnectionErrorMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ConnectionError
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V3.ConnectionErrorMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V3.ConnectionErrorMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V3.ConnectionIdMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ConnectionId
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V3.ConnectionIdMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V3.ConnectionIdMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V3.ConnectionInfoMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ConnectionInfo
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V3.ConnectionInfoMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V3.ConnectionInfoMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V3.ConsumerControlMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ConsumerControl
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V3.ConsumerControlMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V3.ConsumerControlMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V3.ConsumerIdMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ConsumerId
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V3.ConsumerIdMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V3.ConsumerIdMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V3.ConsumerInfoMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ConsumerInfo
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V3.ConsumerInfoMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V3.ConsumerInfoMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V3.ControlCommandMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ControlCommand
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V3.ControlCommandMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V3.ControlCommandMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V3.DataArrayResponseMarshaller">
- <summary>
- Marshalling code for Open Wire Format for DataArrayResponse
- </summary>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V3.ResponseMarshaller">
- <summary>
- Marshalling code for Open Wire Format for Response
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V3.ResponseMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V3.ResponseMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V3.DataArrayResponseMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V3.DataArrayResponseMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V3.DataResponseMarshaller">
- <summary>
- Marshalling code for Open Wire Format for DataResponse
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V3.DataResponseMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V3.DataResponseMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V3.DestinationInfoMarshaller">
- <summary>
- Marshalling code for Open Wire Format for DestinationInfo
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V3.DestinationInfoMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V3.DestinationInfoMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V3.DiscoveryEventMarshaller">
- <summary>
- Marshalling code for Open Wire Format for DiscoveryEvent
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V3.DiscoveryEventMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V3.DiscoveryEventMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V3.ExceptionResponseMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ExceptionResponse
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V3.ExceptionResponseMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V3.ExceptionResponseMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V3.FlushCommandMarshaller">
- <summary>
- Marshalling code for Open Wire Format for FlushCommand
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V3.FlushCommandMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V3.FlushCommandMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V3.IntegerResponseMarshaller">
- <summary>
- Marshalling code for Open Wire Format for IntegerResponse
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V3.IntegerResponseMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V3.IntegerResponseMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V3.JournalQueueAckMarshaller">
- <summary>
- Marshalling code for Open Wire Format for JournalQueueAck
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V3.JournalQueueAckMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V3.JournalQueueAckMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V3.JournalTopicAckMarshaller">
- <summary>
- Marshalling code for Open Wire Format for JournalTopicAck
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V3.JournalTopicAckMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V3.JournalTopicAckMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V3.JournalTraceMarshaller">
- <summary>
- Marshalling code for Open Wire Format for JournalTrace
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V3.JournalTraceMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V3.JournalTraceMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V3.JournalTransactionMarshaller">
- <summary>
- Marshalling code for Open Wire Format for JournalTransaction
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V3.JournalTransactionMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V3.JournalTransactionMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V3.KeepAliveInfoMarshaller">
- <summary>
- Marshalling code for Open Wire Format for KeepAliveInfo
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V3.KeepAliveInfoMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V3.KeepAliveInfoMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V3.LastPartialCommandMarshaller">
- <summary>
- Marshalling code for Open Wire Format for LastPartialCommand
- </summary>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V3.PartialCommandMarshaller">
- <summary>
- Marshalling code for Open Wire Format for PartialCommand
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V3.PartialCommandMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V3.PartialCommandMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V3.LastPartialCommandMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V3.LastPartialCommandMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V3.LocalTransactionIdMarshaller">
- <summary>
- Marshalling code for Open Wire Format for LocalTransactionId
- </summary>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V3.TransactionIdMarshaller">
- <summary>
- Marshalling code for Open Wire Format for TransactionId
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V3.LocalTransactionIdMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V3.LocalTransactionIdMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V3.MarshallerFactory">
- <summary>
- Used to create marshallers for a specific version of the OpenWire protocol.
- Each non-abstract DataStructure object has a registered Marshaller that is
- created and added to the OpenWireFormat objects format collection.
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V3.MarshallerFactory.configure(Apache.NMS.ActiveMQ.OpenWire.OpenWireFormat)">
- <summery>
- Adds the Marshallers for this version of the OpenWire protocol to the
- Collection of Marshallers stored in the OpenWireFormat class.
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V3.MessageAckMarshaller">
- <summary>
- Marshalling code for Open Wire Format for MessageAck
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V3.MessageAckMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V3.MessageAckMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V3.MessageDispatchMarshaller">
- <summary>
- Marshalling code for Open Wire Format for MessageDispatch
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V3.MessageDispatchMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V3.MessageDispatchMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V3.MessageDispatchNotificationMarshaller">
- <summary>
- Marshalling code for Open Wire Format for MessageDispatchNotification
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V3.MessageDispatchNotificationMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V3.MessageDispatchNotificationMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V3.MessageIdMarshaller">
- <summary>
- Marshalling code for Open Wire Format for MessageId
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V3.MessageIdMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V3.MessageIdMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V3.MessagePullMarshaller">
- <summary>
- Marshalling code for Open Wire Format for MessagePull
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V3.MessagePullMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V3.MessagePullMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V3.NetworkBridgeFilterMarshaller">
- <summary>
- Marshalling code for Open Wire Format for NetworkBridgeFilter
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V3.NetworkBridgeFilterMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V3.NetworkBridgeFilterMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V3.ProducerAckMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ProducerAck
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V3.ProducerAckMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V3.ProducerAckMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V3.ProducerIdMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ProducerId
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V3.ProducerIdMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V3.ProducerIdMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V3.ProducerInfoMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ProducerInfo
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V3.ProducerInfoMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V3.ProducerInfoMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V3.RemoveInfoMarshaller">
- <summary>
- Marshalling code for Open Wire Format for RemoveInfo
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V3.RemoveInfoMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V3.RemoveInfoMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V3.RemoveSubscriptionInfoMarshaller">
- <summary>
- Marshalling code for Open Wire Format for RemoveSubscriptionInfo
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V3.RemoveSubscriptionInfoMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V3.RemoveSubscriptionInfoMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V3.ReplayCommandMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ReplayCommand
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V3.ReplayCommandMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V3.ReplayCommandMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V3.SessionIdMarshaller">
- <summary>
- Marshalling code for Open Wire Format for SessionId
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V3.SessionIdMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V3.SessionIdMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V3.SessionInfoMarshaller">
- <summary>
- Marshalling code for Open Wire Format for SessionInfo
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V3.SessionInfoMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V3.SessionInfoMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V3.ShutdownInfoMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ShutdownInfo
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V3.ShutdownInfoMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V3.ShutdownInfoMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V3.SubscriptionInfoMarshaller">
- <summary>
- Marshalling code for Open Wire Format for SubscriptionInfo
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V3.SubscriptionInfoMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V3.SubscriptionInfoMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V3.TransactionInfoMarshaller">
- <summary>
- Marshalling code for Open Wire Format for TransactionInfo
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V3.TransactionInfoMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V3.TransactionInfoMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V3.WireFormatInfoMarshaller">
- <summary>
- Marshalling code for Open Wire Format for WireFormatInfo
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V3.WireFormatInfoMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V3.WireFormatInfoMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V3.XATransactionIdMarshaller">
- <summary>
- Marshalling code for Open Wire Format for XATransactionId
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V3.XATransactionIdMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V3.XATransactionIdMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V4.ActiveMQBlobMessageMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ActiveMQBlobMessage
- </summary>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V4.ActiveMQMessageMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ActiveMQMessage
- </summary>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V4.MessageMarshaller">
- <summary>
- Marshalling code for Open Wire Format for Message
- </summary>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V4.BaseCommandMarshaller">
- <summary>
- Marshalling code for Open Wire Format for BaseCommand
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V4.ActiveMQMessageMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V4.ActiveMQMessageMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V4.ActiveMQBlobMessageMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V4.ActiveMQBlobMessageMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V4.ActiveMQBytesMessageMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ActiveMQBytesMessage
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V4.ActiveMQBytesMessageMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V4.ActiveMQBytesMessageMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V4.ActiveMQDestinationMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ActiveMQDestination
- </summary>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V4.ActiveMQMapMessageMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ActiveMQMapMessage
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V4.ActiveMQMapMessageMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V4.ActiveMQMapMessageMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V4.ActiveMQObjectMessageMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ActiveMQObjectMessage
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V4.ActiveMQObjectMessageMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V4.ActiveMQObjectMessageMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V4.ActiveMQQueueMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ActiveMQQueue
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V4.ActiveMQQueueMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V4.ActiveMQQueueMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V4.ActiveMQStreamMessageMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ActiveMQStreamMessage
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V4.ActiveMQStreamMessageMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V4.ActiveMQStreamMessageMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V4.ActiveMQTempDestinationMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ActiveMQTempDestination
- </summary>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V4.ActiveMQTempQueueMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ActiveMQTempQueue
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V4.ActiveMQTempQueueMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V4.ActiveMQTempQueueMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V4.ActiveMQTempTopicMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ActiveMQTempTopic
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V4.ActiveMQTempTopicMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V4.ActiveMQTempTopicMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V4.ActiveMQTextMessageMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ActiveMQTextMessage
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V4.ActiveMQTextMessageMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V4.ActiveMQTextMessageMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V4.ActiveMQTopicMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ActiveMQTopic
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V4.ActiveMQTopicMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V4.ActiveMQTopicMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V4.BrokerIdMarshaller">
- <summary>
- Marshalling code for Open Wire Format for BrokerId
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V4.BrokerIdMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V4.BrokerIdMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V4.BrokerInfoMarshaller">
- <summary>
- Marshalling code for Open Wire Format for BrokerInfo
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V4.BrokerInfoMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V4.BrokerInfoMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V4.ConnectionControlMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ConnectionControl
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V4.ConnectionControlMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V4.ConnectionControlMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V4.ConnectionErrorMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ConnectionError
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V4.ConnectionErrorMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V4.ConnectionErrorMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V4.ConnectionIdMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ConnectionId
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V4.ConnectionIdMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V4.ConnectionIdMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V4.ConnectionInfoMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ConnectionInfo
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V4.ConnectionInfoMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V4.ConnectionInfoMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V4.ConsumerControlMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ConsumerControl
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V4.ConsumerControlMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V4.ConsumerControlMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V4.ConsumerIdMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ConsumerId
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V4.ConsumerIdMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V4.ConsumerIdMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V4.ConsumerInfoMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ConsumerInfo
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V4.ConsumerInfoMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V4.ConsumerInfoMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V4.ControlCommandMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ControlCommand
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V4.ControlCommandMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V4.ControlCommandMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V4.DataArrayResponseMarshaller">
- <summary>
- Marshalling code for Open Wire Format for DataArrayResponse
- </summary>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V4.ResponseMarshaller">
- <summary>
- Marshalling code for Open Wire Format for Response
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V4.ResponseMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V4.ResponseMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V4.DataArrayResponseMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V4.DataArrayResponseMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V4.DataResponseMarshaller">
- <summary>
- Marshalling code for Open Wire Format for DataResponse
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V4.DataResponseMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V4.DataResponseMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V4.DestinationInfoMarshaller">
- <summary>
- Marshalling code for Open Wire Format for DestinationInfo
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V4.DestinationInfoMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V4.DestinationInfoMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V4.DiscoveryEventMarshaller">
- <summary>
- Marshalling code for Open Wire Format for DiscoveryEvent
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V4.DiscoveryEventMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V4.DiscoveryEventMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V4.ExceptionResponseMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ExceptionResponse
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V4.ExceptionResponseMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V4.ExceptionResponseMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V4.FlushCommandMarshaller">
- <summary>
- Marshalling code for Open Wire Format for FlushCommand
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V4.FlushCommandMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V4.FlushCommandMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V4.IntegerResponseMarshaller">
- <summary>
- Marshalling code for Open Wire Format for IntegerResponse
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V4.IntegerResponseMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V4.IntegerResponseMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V4.JournalQueueAckMarshaller">
- <summary>
- Marshalling code for Open Wire Format for JournalQueueAck
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V4.JournalQueueAckMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V4.JournalQueueAckMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V4.JournalTopicAckMarshaller">
- <summary>
- Marshalling code for Open Wire Format for JournalTopicAck
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V4.JournalTopicAckMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V4.JournalTopicAckMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V4.JournalTraceMarshaller">
- <summary>
- Marshalling code for Open Wire Format for JournalTrace
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V4.JournalTraceMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V4.JournalTraceMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V4.JournalTransactionMarshaller">
- <summary>
- Marshalling code for Open Wire Format for JournalTransaction
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V4.JournalTransactionMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V4.JournalTransactionMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V4.KeepAliveInfoMarshaller">
- <summary>
- Marshalling code for Open Wire Format for KeepAliveInfo
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V4.KeepAliveInfoMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V4.KeepAliveInfoMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V4.LastPartialCommandMarshaller">
- <summary>
- Marshalling code for Open Wire Format for LastPartialCommand
- </summary>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V4.PartialCommandMarshaller">
- <summary>
- Marshalling code for Open Wire Format for PartialCommand
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V4.PartialCommandMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V4.PartialCommandMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V4.LastPartialCommandMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V4.LastPartialCommandMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V4.LocalTransactionIdMarshaller">
- <summary>
- Marshalling code for Open Wire Format for LocalTransactionId
- </summary>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V4.TransactionIdMarshaller">
- <summary>
- Marshalling code for Open Wire Format for TransactionId
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V4.LocalTransactionIdMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V4.LocalTransactionIdMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V4.MarshallerFactory">
- <summary>
- Used to create marshallers for a specific version of the OpenWire protocol.
- Each non-abstract DataStructure object has a registered Marshaller that is
- created and added to the OpenWireFormat objects format collection.
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V4.MarshallerFactory.configure(Apache.NMS.ActiveMQ.OpenWire.OpenWireFormat)">
- <summery>
- Adds the Marshallers for this version of the OpenWire protocol to the
- Collection of Marshallers stored in the OpenWireFormat class.
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V4.MessageAckMarshaller">
- <summary>
- Marshalling code for Open Wire Format for MessageAck
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V4.MessageAckMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V4.MessageAckMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V4.MessageDispatchMarshaller">
- <summary>
- Marshalling code for Open Wire Format for MessageDispatch
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V4.MessageDispatchMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V4.MessageDispatchMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V4.MessageDispatchNotificationMarshaller">
- <summary>
- Marshalling code for Open Wire Format for MessageDispatchNotification
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V4.MessageDispatchNotificationMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V4.MessageDispatchNotificationMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V4.MessageIdMarshaller">
- <summary>
- Marshalling code for Open Wire Format for MessageId
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V4.MessageIdMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V4.MessageIdMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V4.MessagePullMarshaller">
- <summary>
- Marshalling code for Open Wire Format for MessagePull
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V4.MessagePullMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V4.MessagePullMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V4.NetworkBridgeFilterMarshaller">
- <summary>
- Marshalling code for Open Wire Format for NetworkBridgeFilter
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V4.NetworkBridgeFilterMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V4.NetworkBridgeFilterMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V4.ProducerAckMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ProducerAck
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V4.ProducerAckMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V4.ProducerAckMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V4.ProducerIdMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ProducerId
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V4.ProducerIdMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V4.ProducerIdMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V4.ProducerInfoMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ProducerInfo
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V4.ProducerInfoMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V4.ProducerInfoMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V4.RemoveInfoMarshaller">
- <summary>
- Marshalling code for Open Wire Format for RemoveInfo
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V4.RemoveInfoMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V4.RemoveInfoMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V4.RemoveSubscriptionInfoMarshaller">
- <summary>
- Marshalling code for Open Wire Format for RemoveSubscriptionInfo
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V4.RemoveSubscriptionInfoMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V4.RemoveSubscriptionInfoMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V4.ReplayCommandMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ReplayCommand
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V4.ReplayCommandMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V4.ReplayCommandMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V4.SessionIdMarshaller">
- <summary>
- Marshalling code for Open Wire Format for SessionId
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V4.SessionIdMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V4.SessionIdMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V4.SessionInfoMarshaller">
- <summary>
- Marshalling code for Open Wire Format for SessionInfo
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V4.SessionInfoMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V4.SessionInfoMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V4.ShutdownInfoMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ShutdownInfo
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V4.ShutdownInfoMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V4.ShutdownInfoMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V4.SubscriptionInfoMarshaller">
- <summary>
- Marshalling code for Open Wire Format for SubscriptionInfo
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V4.SubscriptionInfoMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V4.SubscriptionInfoMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V4.TransactionInfoMarshaller">
- <summary>
- Marshalling code for Open Wire Format for TransactionInfo
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V4.TransactionInfoMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V4.TransactionInfoMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V4.WireFormatInfoMarshaller">
- <summary>
- Marshalling code for Open Wire Format for WireFormatInfo
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V4.WireFormatInfoMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V4.WireFormatInfoMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V4.XATransactionIdMarshaller">
- <summary>
- Marshalling code for Open Wire Format for XATransactionId
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V4.XATransactionIdMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V4.XATransactionIdMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V5.ActiveMQBlobMessageMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ActiveMQBlobMessage
- </summary>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V5.ActiveMQMessageMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ActiveMQMessage
- </summary>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V5.MessageMarshaller">
- <summary>
- Marshalling code for Open Wire Format for Message
- </summary>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V5.BaseCommandMarshaller">
- <summary>
- Marshalling code for Open Wire Format for BaseCommand
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V5.ActiveMQMessageMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V5.ActiveMQMessageMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V5.ActiveMQBlobMessageMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V5.ActiveMQBlobMessageMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V5.ActiveMQBytesMessageMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ActiveMQBytesMessage
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V5.ActiveMQBytesMessageMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V5.ActiveMQBytesMessageMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V5.ActiveMQDestinationMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ActiveMQDestination
- </summary>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V5.ActiveMQMapMessageMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ActiveMQMapMessage
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V5.ActiveMQMapMessageMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V5.ActiveMQMapMessageMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V5.ActiveMQObjectMessageMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ActiveMQObjectMessage
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V5.ActiveMQObjectMessageMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V5.ActiveMQObjectMessageMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V5.ActiveMQQueueMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ActiveMQQueue
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V5.ActiveMQQueueMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V5.ActiveMQQueueMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V5.ActiveMQStreamMessageMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ActiveMQStreamMessage
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V5.ActiveMQStreamMessageMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V5.ActiveMQStreamMessageMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V5.ActiveMQTempDestinationMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ActiveMQTempDestination
- </summary>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V5.ActiveMQTempQueueMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ActiveMQTempQueue
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V5.ActiveMQTempQueueMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V5.ActiveMQTempQueueMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V5.ActiveMQTempTopicMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ActiveMQTempTopic
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V5.ActiveMQTempTopicMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V5.ActiveMQTempTopicMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V5.ActiveMQTextMessageMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ActiveMQTextMessage
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V5.ActiveMQTextMessageMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V5.ActiveMQTextMessageMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V5.ActiveMQTopicMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ActiveMQTopic
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V5.ActiveMQTopicMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V5.ActiveMQTopicMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V5.BrokerIdMarshaller">
- <summary>
- Marshalling code for Open Wire Format for BrokerId
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V5.BrokerIdMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V5.BrokerIdMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V5.BrokerInfoMarshaller">
- <summary>
- Marshalling code for Open Wire Format for BrokerInfo
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V5.BrokerInfoMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V5.BrokerInfoMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V5.ConnectionControlMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ConnectionControl
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V5.ConnectionControlMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V5.ConnectionControlMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V5.ConnectionErrorMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ConnectionError
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V5.ConnectionErrorMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V5.ConnectionErrorMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V5.ConnectionIdMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ConnectionId
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V5.ConnectionIdMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V5.ConnectionIdMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V5.ConnectionInfoMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ConnectionInfo
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V5.ConnectionInfoMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V5.ConnectionInfoMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V5.ConsumerControlMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ConsumerControl
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V5.ConsumerControlMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V5.ConsumerControlMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V5.ConsumerIdMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ConsumerId
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V5.ConsumerIdMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V5.ConsumerIdMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V5.ConsumerInfoMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ConsumerInfo
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V5.ConsumerInfoMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V5.ConsumerInfoMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V5.ControlCommandMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ControlCommand
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V5.ControlCommandMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V5.ControlCommandMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V5.DataArrayResponseMarshaller">
- <summary>
- Marshalling code for Open Wire Format for DataArrayResponse
- </summary>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V5.ResponseMarshaller">
- <summary>
- Marshalling code for Open Wire Format for Response
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V5.ResponseMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V5.ResponseMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V5.DataArrayResponseMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V5.DataArrayResponseMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V5.DataResponseMarshaller">
- <summary>
- Marshalling code for Open Wire Format for DataResponse
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V5.DataResponseMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V5.DataResponseMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V5.DestinationInfoMarshaller">
- <summary>
- Marshalling code for Open Wire Format for DestinationInfo
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V5.DestinationInfoMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V5.DestinationInfoMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V5.DiscoveryEventMarshaller">
- <summary>
- Marshalling code for Open Wire Format for DiscoveryEvent
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V5.DiscoveryEventMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V5.DiscoveryEventMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V5.ExceptionResponseMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ExceptionResponse
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V5.ExceptionResponseMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V5.ExceptionResponseMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V5.FlushCommandMarshaller">
- <summary>
- Marshalling code for Open Wire Format for FlushCommand
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V5.FlushCommandMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V5.FlushCommandMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V5.IntegerResponseMarshaller">
- <summary>
- Marshalling code for Open Wire Format for IntegerResponse
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V5.IntegerResponseMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V5.IntegerResponseMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V5.JournalQueueAckMarshaller">
- <summary>
- Marshalling code for Open Wire Format for JournalQueueAck
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V5.JournalQueueAckMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V5.JournalQueueAckMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V5.JournalTopicAckMarshaller">
- <summary>
- Marshalling code for Open Wire Format for JournalTopicAck
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V5.JournalTopicAckMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V5.JournalTopicAckMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V5.JournalTraceMarshaller">
- <summary>
- Marshalling code for Open Wire Format for JournalTrace
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V5.JournalTraceMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V5.JournalTraceMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V5.JournalTransactionMarshaller">
- <summary>
- Marshalling code for Open Wire Format for JournalTransaction
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V5.JournalTransactionMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V5.JournalTransactionMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V5.KeepAliveInfoMarshaller">
- <summary>
- Marshalling code for Open Wire Format for KeepAliveInfo
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V5.KeepAliveInfoMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V5.KeepAliveInfoMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V5.LastPartialCommandMarshaller">
- <summary>
- Marshalling code for Open Wire Format for LastPartialCommand
- </summary>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V5.PartialCommandMarshaller">
- <summary>
- Marshalling code for Open Wire Format for PartialCommand
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V5.PartialCommandMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V5.PartialCommandMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V5.LastPartialCommandMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V5.LastPartialCommandMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V5.LocalTransactionIdMarshaller">
- <summary>
- Marshalling code for Open Wire Format for LocalTransactionId
- </summary>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V5.TransactionIdMarshaller">
- <summary>
- Marshalling code for Open Wire Format for TransactionId
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V5.LocalTransactionIdMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V5.LocalTransactionIdMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V5.MarshallerFactory">
- <summary>
- Used to create marshallers for a specific version of the OpenWire protocol.
- Each non-abstract DataStructure object has a registered Marshaller that is
- created and added to the OpenWireFormat objects format collection.
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V5.MarshallerFactory.configure(Apache.NMS.ActiveMQ.OpenWire.OpenWireFormat)">
- <summery>
- Adds the Marshallers for this version of the OpenWire protocol to the
- Collection of Marshallers stored in the OpenWireFormat class.
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V5.MessageAckMarshaller">
- <summary>
- Marshalling code for Open Wire Format for MessageAck
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V5.MessageAckMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V5.MessageAckMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V5.MessageDispatchMarshaller">
- <summary>
- Marshalling code for Open Wire Format for MessageDispatch
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V5.MessageDispatchMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V5.MessageDispatchMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V5.MessageDispatchNotificationMarshaller">
- <summary>
- Marshalling code for Open Wire Format for MessageDispatchNotification
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V5.MessageDispatchNotificationMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V5.MessageDispatchNotificationMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V5.MessageIdMarshaller">
- <summary>
- Marshalling code for Open Wire Format for MessageId
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V5.MessageIdMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V5.MessageIdMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V5.MessagePullMarshaller">
- <summary>
- Marshalling code for Open Wire Format for MessagePull
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V5.MessagePullMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V5.MessagePullMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V5.NetworkBridgeFilterMarshaller">
- <summary>
- Marshalling code for Open Wire Format for NetworkBridgeFilter
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V5.NetworkBridgeFilterMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V5.NetworkBridgeFilterMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V5.ProducerAckMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ProducerAck
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V5.ProducerAckMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V5.ProducerAckMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V5.ProducerIdMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ProducerId
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V5.ProducerIdMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V5.ProducerIdMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V5.ProducerInfoMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ProducerInfo
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V5.ProducerInfoMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V5.ProducerInfoMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V5.RemoveInfoMarshaller">
- <summary>
- Marshalling code for Open Wire Format for RemoveInfo
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V5.RemoveInfoMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V5.RemoveInfoMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V5.RemoveSubscriptionInfoMarshaller">
- <summary>
- Marshalling code for Open Wire Format for RemoveSubscriptionInfo
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V5.RemoveSubscriptionInfoMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V5.RemoveSubscriptionInfoMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V5.ReplayCommandMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ReplayCommand
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V5.ReplayCommandMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V5.ReplayCommandMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V5.SessionIdMarshaller">
- <summary>
- Marshalling code for Open Wire Format for SessionId
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V5.SessionIdMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V5.SessionIdMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V5.SessionInfoMarshaller">
- <summary>
- Marshalling code for Open Wire Format for SessionInfo
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V5.SessionInfoMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V5.SessionInfoMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V5.ShutdownInfoMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ShutdownInfo
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V5.ShutdownInfoMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V5.ShutdownInfoMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V5.SubscriptionInfoMarshaller">
- <summary>
- Marshalling code for Open Wire Format for SubscriptionInfo
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V5.SubscriptionInfoMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V5.SubscriptionInfoMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V5.TransactionInfoMarshaller">
- <summary>
- Marshalling code for Open Wire Format for TransactionInfo
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V5.TransactionInfoMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V5.TransactionInfoMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V5.WireFormatInfoMarshaller">
- <summary>
- Marshalling code for Open Wire Format for WireFormatInfo
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V5.WireFormatInfoMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V5.WireFormatInfoMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V5.XATransactionIdMarshaller">
- <summary>
- Marshalling code for Open Wire Format for XATransactionId
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V5.XATransactionIdMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V5.XATransactionIdMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V6.ActiveMQBlobMessageMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ActiveMQBlobMessage
- </summary>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V6.ActiveMQMessageMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ActiveMQMessage
- </summary>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V6.MessageMarshaller">
- <summary>
- Marshalling code for Open Wire Format for Message
- </summary>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V6.BaseCommandMarshaller">
- <summary>
- Marshalling code for Open Wire Format for BaseCommand
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V6.ActiveMQMessageMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V6.ActiveMQMessageMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V6.ActiveMQBlobMessageMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V6.ActiveMQBlobMessageMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V6.ActiveMQBytesMessageMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ActiveMQBytesMessage
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V6.ActiveMQBytesMessageMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V6.ActiveMQBytesMessageMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V6.ActiveMQDestinationMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ActiveMQDestination
- </summary>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V6.ActiveMQMapMessageMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ActiveMQMapMessage
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V6.ActiveMQMapMessageMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V6.ActiveMQMapMessageMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V6.ActiveMQObjectMessageMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ActiveMQObjectMessage
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V6.ActiveMQObjectMessageMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V6.ActiveMQObjectMessageMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V6.ActiveMQQueueMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ActiveMQQueue
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V6.ActiveMQQueueMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V6.ActiveMQQueueMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V6.ActiveMQStreamMessageMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ActiveMQStreamMessage
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V6.ActiveMQStreamMessageMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V6.ActiveMQStreamMessageMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V6.ActiveMQTempDestinationMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ActiveMQTempDestination
- </summary>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V6.ActiveMQTempQueueMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ActiveMQTempQueue
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V6.ActiveMQTempQueueMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V6.ActiveMQTempQueueMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V6.ActiveMQTempTopicMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ActiveMQTempTopic
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V6.ActiveMQTempTopicMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V6.ActiveMQTempTopicMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V6.ActiveMQTextMessageMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ActiveMQTextMessage
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V6.ActiveMQTextMessageMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V6.ActiveMQTextMessageMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V6.ActiveMQTopicMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ActiveMQTopic
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V6.ActiveMQTopicMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V6.ActiveMQTopicMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V6.BrokerIdMarshaller">
- <summary>
- Marshalling code for Open Wire Format for BrokerId
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V6.BrokerIdMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V6.BrokerIdMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V6.BrokerInfoMarshaller">
- <summary>
- Marshalling code for Open Wire Format for BrokerInfo
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V6.BrokerInfoMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V6.BrokerInfoMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V6.ConnectionControlMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ConnectionControl
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V6.ConnectionControlMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V6.ConnectionControlMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V6.ConnectionErrorMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ConnectionError
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V6.ConnectionErrorMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V6.ConnectionErrorMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V6.ConnectionIdMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ConnectionId
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V6.ConnectionIdMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V6.ConnectionIdMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V6.ConnectionInfoMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ConnectionInfo
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V6.ConnectionInfoMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V6.ConnectionInfoMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V6.ConsumerControlMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ConsumerControl
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V6.ConsumerControlMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V6.ConsumerControlMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V6.ConsumerIdMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ConsumerId
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V6.ConsumerIdMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V6.ConsumerIdMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V6.ConsumerInfoMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ConsumerInfo
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V6.ConsumerInfoMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V6.ConsumerInfoMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V6.ControlCommandMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ControlCommand
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V6.ControlCommandMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V6.ControlCommandMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V6.DataArrayResponseMarshaller">
- <summary>
- Marshalling code for Open Wire Format for DataArrayResponse
- </summary>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V6.ResponseMarshaller">
- <summary>
- Marshalling code for Open Wire Format for Response
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V6.ResponseMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V6.ResponseMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V6.DataArrayResponseMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V6.DataArrayResponseMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V6.DataResponseMarshaller">
- <summary>
- Marshalling code for Open Wire Format for DataResponse
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V6.DataResponseMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V6.DataResponseMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V6.DestinationInfoMarshaller">
- <summary>
- Marshalling code for Open Wire Format for DestinationInfo
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V6.DestinationInfoMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V6.DestinationInfoMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V6.DiscoveryEventMarshaller">
- <summary>
- Marshalling code for Open Wire Format for DiscoveryEvent
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V6.DiscoveryEventMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V6.DiscoveryEventMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V6.ExceptionResponseMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ExceptionResponse
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V6.ExceptionResponseMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V6.ExceptionResponseMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V6.FlushCommandMarshaller">
- <summary>
- Marshalling code for Open Wire Format for FlushCommand
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V6.FlushCommandMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V6.FlushCommandMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V6.IntegerResponseMarshaller">
- <summary>
- Marshalling code for Open Wire Format for IntegerResponse
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V6.IntegerResponseMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V6.IntegerResponseMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V6.JournalQueueAckMarshaller">
- <summary>
- Marshalling code for Open Wire Format for JournalQueueAck
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V6.JournalQueueAckMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V6.JournalQueueAckMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V6.JournalTopicAckMarshaller">
- <summary>
- Marshalling code for Open Wire Format for JournalTopicAck
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V6.JournalTopicAckMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V6.JournalTopicAckMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V6.JournalTraceMarshaller">
- <summary>
- Marshalling code for Open Wire Format for JournalTrace
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V6.JournalTraceMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V6.JournalTraceMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V6.JournalTransactionMarshaller">
- <summary>
- Marshalling code for Open Wire Format for JournalTransaction
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V6.JournalTransactionMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V6.JournalTransactionMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V6.KeepAliveInfoMarshaller">
- <summary>
- Marshalling code for Open Wire Format for KeepAliveInfo
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V6.KeepAliveInfoMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V6.KeepAliveInfoMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V6.LastPartialCommandMarshaller">
- <summary>
- Marshalling code for Open Wire Format for LastPartialCommand
- </summary>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V6.PartialCommandMarshaller">
- <summary>
- Marshalling code for Open Wire Format for PartialCommand
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V6.PartialCommandMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V6.PartialCommandMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V6.LastPartialCommandMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V6.LastPartialCommandMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V6.LocalTransactionIdMarshaller">
- <summary>
- Marshalling code for Open Wire Format for LocalTransactionId
- </summary>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V6.TransactionIdMarshaller">
- <summary>
- Marshalling code for Open Wire Format for TransactionId
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V6.LocalTransactionIdMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V6.LocalTransactionIdMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V6.MarshallerFactory">
- <summary>
- Used to create marshallers for a specific version of the OpenWire protocol.
- Each non-abstract DataStructure object has a registered Marshaller that is
- created and added to the OpenWireFormat objects format collection.
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V6.MarshallerFactory.configure(Apache.NMS.ActiveMQ.OpenWire.OpenWireFormat)">
- <summery>
- Adds the Marshallers for this version of the OpenWire protocol to the
- Collection of Marshallers stored in the OpenWireFormat class.
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V6.MessageAckMarshaller">
- <summary>
- Marshalling code for Open Wire Format for MessageAck
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V6.MessageAckMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V6.MessageAckMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V6.MessageDispatchMarshaller">
- <summary>
- Marshalling code for Open Wire Format for MessageDispatch
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V6.MessageDispatchMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V6.MessageDispatchMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V6.MessageDispatchNotificationMarshaller">
- <summary>
- Marshalling code for Open Wire Format for MessageDispatchNotification
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V6.MessageDispatchNotificationMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V6.MessageDispatchNotificationMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V6.MessageIdMarshaller">
- <summary>
- Marshalling code for Open Wire Format for MessageId
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V6.MessageIdMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V6.MessageIdMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V6.MessagePullMarshaller">
- <summary>
- Marshalling code for Open Wire Format for MessagePull
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V6.MessagePullMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V6.MessagePullMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V6.NetworkBridgeFilterMarshaller">
- <summary>
- Marshalling code for Open Wire Format for NetworkBridgeFilter
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V6.NetworkBridgeFilterMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V6.NetworkBridgeFilterMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V6.ProducerAckMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ProducerAck
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V6.ProducerAckMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V6.ProducerAckMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V6.ProducerIdMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ProducerId
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V6.ProducerIdMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V6.ProducerIdMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V6.ProducerInfoMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ProducerInfo
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V6.ProducerInfoMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V6.ProducerInfoMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V6.RemoveInfoMarshaller">
- <summary>
- Marshalling code for Open Wire Format for RemoveInfo
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V6.RemoveInfoMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V6.RemoveInfoMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V6.RemoveSubscriptionInfoMarshaller">
- <summary>
- Marshalling code for Open Wire Format for RemoveSubscriptionInfo
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V6.RemoveSubscriptionInfoMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V6.RemoveSubscriptionInfoMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V6.ReplayCommandMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ReplayCommand
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V6.ReplayCommandMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V6.ReplayCommandMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V6.SessionIdMarshaller">
- <summary>
- Marshalling code for Open Wire Format for SessionId
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V6.SessionIdMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V6.SessionIdMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V6.SessionInfoMarshaller">
- <summary>
- Marshalling code for Open Wire Format for SessionInfo
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V6.SessionInfoMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V6.SessionInfoMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V6.ShutdownInfoMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ShutdownInfo
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V6.ShutdownInfoMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V6.ShutdownInfoMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V6.SubscriptionInfoMarshaller">
- <summary>
- Marshalling code for Open Wire Format for SubscriptionInfo
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V6.SubscriptionInfoMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V6.SubscriptionInfoMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V6.TransactionInfoMarshaller">
- <summary>
- Marshalling code for Open Wire Format for TransactionInfo
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V6.TransactionInfoMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V6.TransactionInfoMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V6.WireFormatInfoMarshaller">
- <summary>
- Marshalling code for Open Wire Format for WireFormatInfo
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V6.WireFormatInfoMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V6.WireFormatInfoMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V6.XATransactionIdMarshaller">
- <summary>
- Marshalling code for Open Wire Format for XATransactionId
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V6.XATransactionIdMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V6.XATransactionIdMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V7.ActiveMQBlobMessageMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ActiveMQBlobMessage
- </summary>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V7.ActiveMQMessageMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ActiveMQMessage
- </summary>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V7.MessageMarshaller">
- <summary>
- Marshalling code for Open Wire Format for Message
- </summary>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V7.BaseCommandMarshaller">
- <summary>
- Marshalling code for Open Wire Format for BaseCommand
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V7.ActiveMQMessageMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V7.ActiveMQMessageMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V7.ActiveMQBlobMessageMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V7.ActiveMQBlobMessageMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V7.ActiveMQBytesMessageMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ActiveMQBytesMessage
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V7.ActiveMQBytesMessageMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V7.ActiveMQBytesMessageMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V7.ActiveMQDestinationMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ActiveMQDestination
- </summary>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V7.ActiveMQMapMessageMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ActiveMQMapMessage
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V7.ActiveMQMapMessageMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V7.ActiveMQMapMessageMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V7.ActiveMQObjectMessageMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ActiveMQObjectMessage
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V7.ActiveMQObjectMessageMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V7.ActiveMQObjectMessageMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V7.ActiveMQQueueMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ActiveMQQueue
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V7.ActiveMQQueueMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V7.ActiveMQQueueMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V7.ActiveMQStreamMessageMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ActiveMQStreamMessage
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V7.ActiveMQStreamMessageMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V7.ActiveMQStreamMessageMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V7.ActiveMQTempDestinationMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ActiveMQTempDestination
- </summary>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V7.ActiveMQTempQueueMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ActiveMQTempQueue
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V7.ActiveMQTempQueueMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V7.ActiveMQTempQueueMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V7.ActiveMQTempTopicMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ActiveMQTempTopic
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V7.ActiveMQTempTopicMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V7.ActiveMQTempTopicMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V7.ActiveMQTextMessageMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ActiveMQTextMessage
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V7.ActiveMQTextMessageMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V7.ActiveMQTextMessageMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V7.ActiveMQTopicMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ActiveMQTopic
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V7.ActiveMQTopicMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V7.ActiveMQTopicMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V7.BrokerIdMarshaller">
- <summary>
- Marshalling code for Open Wire Format for BrokerId
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V7.BrokerIdMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V7.BrokerIdMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V7.BrokerInfoMarshaller">
- <summary>
- Marshalling code for Open Wire Format for BrokerInfo
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V7.BrokerInfoMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V7.BrokerInfoMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V7.ConnectionControlMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ConnectionControl
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V7.ConnectionControlMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V7.ConnectionControlMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V7.ConnectionErrorMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ConnectionError
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V7.ConnectionErrorMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V7.ConnectionErrorMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V7.ConnectionIdMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ConnectionId
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V7.ConnectionIdMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V7.ConnectionIdMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V7.ConnectionInfoMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ConnectionInfo
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V7.ConnectionInfoMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V7.ConnectionInfoMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V7.ConsumerControlMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ConsumerControl
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V7.ConsumerControlMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V7.ConsumerControlMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V7.ConsumerIdMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ConsumerId
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V7.ConsumerIdMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V7.ConsumerIdMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V7.ConsumerInfoMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ConsumerInfo
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V7.ConsumerInfoMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V7.ConsumerInfoMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V7.ControlCommandMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ControlCommand
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V7.ControlCommandMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V7.ControlCommandMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V7.DataArrayResponseMarshaller">
- <summary>
- Marshalling code for Open Wire Format for DataArrayResponse
- </summary>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V7.ResponseMarshaller">
- <summary>
- Marshalling code for Open Wire Format for Response
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V7.ResponseMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V7.ResponseMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V7.DataArrayResponseMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V7.DataArrayResponseMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V7.DataResponseMarshaller">
- <summary>
- Marshalling code for Open Wire Format for DataResponse
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V7.DataResponseMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V7.DataResponseMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V7.DestinationInfoMarshaller">
- <summary>
- Marshalling code for Open Wire Format for DestinationInfo
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V7.DestinationInfoMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V7.DestinationInfoMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V7.DiscoveryEventMarshaller">
- <summary>
- Marshalling code for Open Wire Format for DiscoveryEvent
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V7.DiscoveryEventMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V7.DiscoveryEventMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V7.ExceptionResponseMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ExceptionResponse
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V7.ExceptionResponseMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V7.ExceptionResponseMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V7.FlushCommandMarshaller">
- <summary>
- Marshalling code for Open Wire Format for FlushCommand
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V7.FlushCommandMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V7.FlushCommandMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V7.IntegerResponseMarshaller">
- <summary>
- Marshalling code for Open Wire Format for IntegerResponse
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V7.IntegerResponseMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V7.IntegerResponseMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V7.JournalQueueAckMarshaller">
- <summary>
- Marshalling code for Open Wire Format for JournalQueueAck
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V7.JournalQueueAckMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V7.JournalQueueAckMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V7.JournalTopicAckMarshaller">
- <summary>
- Marshalling code for Open Wire Format for JournalTopicAck
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V7.JournalTopicAckMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V7.JournalTopicAckMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V7.JournalTraceMarshaller">
- <summary>
- Marshalling code for Open Wire Format for JournalTrace
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V7.JournalTraceMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V7.JournalTraceMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V7.JournalTransactionMarshaller">
- <summary>
- Marshalling code for Open Wire Format for JournalTransaction
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V7.JournalTransactionMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V7.JournalTransactionMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V7.KeepAliveInfoMarshaller">
- <summary>
- Marshalling code for Open Wire Format for KeepAliveInfo
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V7.KeepAliveInfoMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V7.KeepAliveInfoMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V7.LastPartialCommandMarshaller">
- <summary>
- Marshalling code for Open Wire Format for LastPartialCommand
- </summary>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V7.PartialCommandMarshaller">
- <summary>
- Marshalling code for Open Wire Format for PartialCommand
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V7.PartialCommandMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V7.PartialCommandMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V7.LastPartialCommandMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V7.LastPartialCommandMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V7.LocalTransactionIdMarshaller">
- <summary>
- Marshalling code for Open Wire Format for LocalTransactionId
- </summary>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V7.TransactionIdMarshaller">
- <summary>
- Marshalling code for Open Wire Format for TransactionId
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V7.LocalTransactionIdMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V7.LocalTransactionIdMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V7.MarshallerFactory">
- <summary>
- Used to create marshallers for a specific version of the OpenWire protocol.
- Each non-abstract DataStructure object has a registered Marshaller that is
- created and added to the OpenWireFormat objects format collection.
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V7.MarshallerFactory.configure(Apache.NMS.ActiveMQ.OpenWire.OpenWireFormat)">
- <summery>
- Adds the Marshallers for this version of the OpenWire protocol to the
- Collection of Marshallers stored in the OpenWireFormat class.
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V7.MessageAckMarshaller">
- <summary>
- Marshalling code for Open Wire Format for MessageAck
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V7.MessageAckMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V7.MessageAckMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V7.MessageDispatchMarshaller">
- <summary>
- Marshalling code for Open Wire Format for MessageDispatch
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V7.MessageDispatchMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V7.MessageDispatchMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V7.MessageDispatchNotificationMarshaller">
- <summary>
- Marshalling code for Open Wire Format for MessageDispatchNotification
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V7.MessageDispatchNotificationMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V7.MessageDispatchNotificationMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V7.MessageIdMarshaller">
- <summary>
- Marshalling code for Open Wire Format for MessageId
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V7.MessageIdMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V7.MessageIdMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V7.MessagePullMarshaller">
- <summary>
- Marshalling code for Open Wire Format for MessagePull
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V7.MessagePullMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V7.MessagePullMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V7.NetworkBridgeFilterMarshaller">
- <summary>
- Marshalling code for Open Wire Format for NetworkBridgeFilter
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V7.NetworkBridgeFilterMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V7.NetworkBridgeFilterMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V7.ProducerAckMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ProducerAck
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V7.ProducerAckMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V7.ProducerAckMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V7.ProducerIdMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ProducerId
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V7.ProducerIdMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V7.ProducerIdMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V7.ProducerInfoMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ProducerInfo
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V7.ProducerInfoMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V7.ProducerInfoMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V7.RemoveInfoMarshaller">
- <summary>
- Marshalling code for Open Wire Format for RemoveInfo
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V7.RemoveInfoMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V7.RemoveInfoMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V7.RemoveSubscriptionInfoMarshaller">
- <summary>
- Marshalling code for Open Wire Format for RemoveSubscriptionInfo
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V7.RemoveSubscriptionInfoMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V7.RemoveSubscriptionInfoMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V7.ReplayCommandMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ReplayCommand
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V7.ReplayCommandMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V7.ReplayCommandMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V7.SessionIdMarshaller">
- <summary>
- Marshalling code for Open Wire Format for SessionId
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V7.SessionIdMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V7.SessionIdMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V7.SessionInfoMarshaller">
- <summary>
- Marshalling code for Open Wire Format for SessionInfo
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V7.SessionInfoMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V7.SessionInfoMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V7.ShutdownInfoMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ShutdownInfo
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V7.ShutdownInfoMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V7.ShutdownInfoMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V7.SubscriptionInfoMarshaller">
- <summary>
- Marshalling code for Open Wire Format for SubscriptionInfo
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V7.SubscriptionInfoMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V7.SubscriptionInfoMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V7.TransactionInfoMarshaller">
- <summary>
- Marshalling code for Open Wire Format for TransactionInfo
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V7.TransactionInfoMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V7.TransactionInfoMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V7.WireFormatInfoMarshaller">
- <summary>
- Marshalling code for Open Wire Format for WireFormatInfo
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V7.WireFormatInfoMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V7.WireFormatInfoMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V7.XATransactionIdMarshaller">
- <summary>
- Marshalling code for Open Wire Format for XATransactionId
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V7.XATransactionIdMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V7.XATransactionIdMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V8.ActiveMQBlobMessageMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ActiveMQBlobMessage
- </summary>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V8.ActiveMQMessageMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ActiveMQMessage
- </summary>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V8.MessageMarshaller">
- <summary>
- Marshalling code for Open Wire Format for Message
- </summary>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V8.BaseCommandMarshaller">
- <summary>
- Marshalling code for Open Wire Format for BaseCommand
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V8.ActiveMQMessageMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V8.ActiveMQMessageMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V8.ActiveMQBlobMessageMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V8.ActiveMQBlobMessageMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V8.ActiveMQBytesMessageMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ActiveMQBytesMessage
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V8.ActiveMQBytesMessageMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V8.ActiveMQBytesMessageMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V8.ActiveMQDestinationMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ActiveMQDestination
- </summary>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V8.ActiveMQMapMessageMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ActiveMQMapMessage
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V8.ActiveMQMapMessageMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V8.ActiveMQMapMessageMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V8.ActiveMQObjectMessageMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ActiveMQObjectMessage
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V8.ActiveMQObjectMessageMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V8.ActiveMQObjectMessageMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V8.ActiveMQQueueMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ActiveMQQueue
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V8.ActiveMQQueueMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V8.ActiveMQQueueMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V8.ActiveMQStreamMessageMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ActiveMQStreamMessage
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V8.ActiveMQStreamMessageMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V8.ActiveMQStreamMessageMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V8.ActiveMQTempDestinationMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ActiveMQTempDestination
- </summary>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V8.ActiveMQTempQueueMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ActiveMQTempQueue
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V8.ActiveMQTempQueueMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V8.ActiveMQTempQueueMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V8.ActiveMQTempTopicMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ActiveMQTempTopic
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V8.ActiveMQTempTopicMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V8.ActiveMQTempTopicMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V8.ActiveMQTextMessageMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ActiveMQTextMessage
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V8.ActiveMQTextMessageMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V8.ActiveMQTextMessageMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V8.ActiveMQTopicMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ActiveMQTopic
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V8.ActiveMQTopicMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V8.ActiveMQTopicMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V8.BrokerIdMarshaller">
- <summary>
- Marshalling code for Open Wire Format for BrokerId
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V8.BrokerIdMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V8.BrokerIdMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V8.BrokerInfoMarshaller">
- <summary>
- Marshalling code for Open Wire Format for BrokerInfo
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V8.BrokerInfoMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V8.BrokerInfoMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V8.ConnectionControlMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ConnectionControl
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V8.ConnectionControlMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V8.ConnectionControlMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V8.ConnectionErrorMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ConnectionError
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V8.ConnectionErrorMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V8.ConnectionErrorMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V8.ConnectionIdMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ConnectionId
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V8.ConnectionIdMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V8.ConnectionIdMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V8.ConnectionInfoMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ConnectionInfo
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V8.ConnectionInfoMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V8.ConnectionInfoMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V8.ConsumerControlMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ConsumerControl
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V8.ConsumerControlMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V8.ConsumerControlMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V8.ConsumerIdMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ConsumerId
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V8.ConsumerIdMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V8.ConsumerIdMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V8.ConsumerInfoMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ConsumerInfo
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V8.ConsumerInfoMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V8.ConsumerInfoMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V8.ControlCommandMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ControlCommand
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V8.ControlCommandMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V8.ControlCommandMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V8.DataArrayResponseMarshaller">
- <summary>
- Marshalling code for Open Wire Format for DataArrayResponse
- </summary>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V8.ResponseMarshaller">
- <summary>
- Marshalling code for Open Wire Format for Response
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V8.ResponseMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V8.ResponseMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V8.DataArrayResponseMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V8.DataArrayResponseMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V8.DataResponseMarshaller">
- <summary>
- Marshalling code for Open Wire Format for DataResponse
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V8.DataResponseMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V8.DataResponseMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V8.DestinationInfoMarshaller">
- <summary>
- Marshalling code for Open Wire Format for DestinationInfo
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V8.DestinationInfoMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V8.DestinationInfoMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V8.DiscoveryEventMarshaller">
- <summary>
- Marshalling code for Open Wire Format for DiscoveryEvent
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V8.DiscoveryEventMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V8.DiscoveryEventMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V8.ExceptionResponseMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ExceptionResponse
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V8.ExceptionResponseMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V8.ExceptionResponseMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V8.FlushCommandMarshaller">
- <summary>
- Marshalling code for Open Wire Format for FlushCommand
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V8.FlushCommandMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V8.FlushCommandMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V8.IntegerResponseMarshaller">
- <summary>
- Marshalling code for Open Wire Format for IntegerResponse
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V8.IntegerResponseMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V8.IntegerResponseMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V8.JournalQueueAckMarshaller">
- <summary>
- Marshalling code for Open Wire Format for JournalQueueAck
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V8.JournalQueueAckMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V8.JournalQueueAckMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V8.JournalTopicAckMarshaller">
- <summary>
- Marshalling code for Open Wire Format for JournalTopicAck
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V8.JournalTopicAckMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V8.JournalTopicAckMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V8.JournalTraceMarshaller">
- <summary>
- Marshalling code for Open Wire Format for JournalTrace
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V8.JournalTraceMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V8.JournalTraceMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V8.JournalTransactionMarshaller">
- <summary>
- Marshalling code for Open Wire Format for JournalTransaction
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V8.JournalTransactionMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V8.JournalTransactionMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V8.KeepAliveInfoMarshaller">
- <summary>
- Marshalling code for Open Wire Format for KeepAliveInfo
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V8.KeepAliveInfoMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V8.KeepAliveInfoMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V8.LastPartialCommandMarshaller">
- <summary>
- Marshalling code for Open Wire Format for LastPartialCommand
- </summary>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V8.PartialCommandMarshaller">
- <summary>
- Marshalling code for Open Wire Format for PartialCommand
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V8.PartialCommandMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V8.PartialCommandMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V8.LastPartialCommandMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V8.LastPartialCommandMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V8.LocalTransactionIdMarshaller">
- <summary>
- Marshalling code for Open Wire Format for LocalTransactionId
- </summary>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V8.TransactionIdMarshaller">
- <summary>
- Marshalling code for Open Wire Format for TransactionId
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V8.LocalTransactionIdMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V8.LocalTransactionIdMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V8.MarshallerFactory">
- <summary>
- Used to create marshallers for a specific version of the OpenWire protocol.
- Each non-abstract DataStructure object has a registered Marshaller that is
- created and added to the OpenWireFormat objects format collection.
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V8.MarshallerFactory.configure(Apache.NMS.ActiveMQ.OpenWire.OpenWireFormat)">
- <summery>
- Adds the Marshallers for this version of the OpenWire protocol to the
- Collection of Marshallers stored in the OpenWireFormat class.
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V8.MessageAckMarshaller">
- <summary>
- Marshalling code for Open Wire Format for MessageAck
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V8.MessageAckMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V8.MessageAckMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V8.MessageDispatchMarshaller">
- <summary>
- Marshalling code for Open Wire Format for MessageDispatch
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V8.MessageDispatchMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V8.MessageDispatchMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V8.MessageDispatchNotificationMarshaller">
- <summary>
- Marshalling code for Open Wire Format for MessageDispatchNotification
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V8.MessageDispatchNotificationMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V8.MessageDispatchNotificationMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V8.MessageIdMarshaller">
- <summary>
- Marshalling code for Open Wire Format for MessageId
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V8.MessageIdMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V8.MessageIdMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V8.MessagePullMarshaller">
- <summary>
- Marshalling code for Open Wire Format for MessagePull
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V8.MessagePullMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V8.MessagePullMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V8.NetworkBridgeFilterMarshaller">
- <summary>
- Marshalling code for Open Wire Format for NetworkBridgeFilter
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V8.NetworkBridgeFilterMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V8.NetworkBridgeFilterMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V8.ProducerAckMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ProducerAck
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V8.ProducerAckMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V8.ProducerAckMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V8.ProducerIdMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ProducerId
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V8.ProducerIdMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V8.ProducerIdMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V8.ProducerInfoMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ProducerInfo
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V8.ProducerInfoMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V8.ProducerInfoMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V8.RemoveInfoMarshaller">
- <summary>
- Marshalling code for Open Wire Format for RemoveInfo
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V8.RemoveInfoMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V8.RemoveInfoMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V8.RemoveSubscriptionInfoMarshaller">
- <summary>
- Marshalling code for Open Wire Format for RemoveSubscriptionInfo
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V8.RemoveSubscriptionInfoMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V8.RemoveSubscriptionInfoMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V8.ReplayCommandMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ReplayCommand
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V8.ReplayCommandMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V8.ReplayCommandMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V8.SessionIdMarshaller">
- <summary>
- Marshalling code for Open Wire Format for SessionId
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V8.SessionIdMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V8.SessionIdMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V8.SessionInfoMarshaller">
- <summary>
- Marshalling code for Open Wire Format for SessionInfo
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V8.SessionInfoMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V8.SessionInfoMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V8.ShutdownInfoMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ShutdownInfo
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V8.ShutdownInfoMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V8.ShutdownInfoMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V8.SubscriptionInfoMarshaller">
- <summary>
- Marshalling code for Open Wire Format for SubscriptionInfo
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V8.SubscriptionInfoMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V8.SubscriptionInfoMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V8.TransactionInfoMarshaller">
- <summary>
- Marshalling code for Open Wire Format for TransactionInfo
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V8.TransactionInfoMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V8.TransactionInfoMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V8.WireFormatInfoMarshaller">
- <summary>
- Marshalling code for Open Wire Format for WireFormatInfo
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V8.WireFormatInfoMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V8.WireFormatInfoMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V8.XATransactionIdMarshaller">
- <summary>
- Marshalling code for Open Wire Format for XATransactionId
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V8.XATransactionIdMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V8.XATransactionIdMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V9.ActiveMQBlobMessageMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ActiveMQBlobMessage
- </summary>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V9.ActiveMQMessageMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ActiveMQMessage
- </summary>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V9.MessageMarshaller">
- <summary>
- Marshalling code for Open Wire Format for Message
- </summary>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V9.BaseCommandMarshaller">
- <summary>
- Marshalling code for Open Wire Format for BaseCommand
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V9.ActiveMQMessageMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V9.ActiveMQMessageMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V9.ActiveMQBlobMessageMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V9.ActiveMQBlobMessageMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V9.ActiveMQBytesMessageMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ActiveMQBytesMessage
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V9.ActiveMQBytesMessageMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V9.ActiveMQBytesMessageMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V9.ActiveMQDestinationMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ActiveMQDestination
- </summary>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V9.ActiveMQMapMessageMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ActiveMQMapMessage
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V9.ActiveMQMapMessageMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V9.ActiveMQMapMessageMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V9.ActiveMQObjectMessageMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ActiveMQObjectMessage
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V9.ActiveMQObjectMessageMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V9.ActiveMQObjectMessageMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V9.ActiveMQQueueMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ActiveMQQueue
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V9.ActiveMQQueueMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V9.ActiveMQQueueMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V9.ActiveMQStreamMessageMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ActiveMQStreamMessage
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V9.ActiveMQStreamMessageMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V9.ActiveMQStreamMessageMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V9.ActiveMQTempDestinationMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ActiveMQTempDestination
- </summary>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V9.ActiveMQTempQueueMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ActiveMQTempQueue
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V9.ActiveMQTempQueueMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V9.ActiveMQTempQueueMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V9.ActiveMQTempTopicMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ActiveMQTempTopic
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V9.ActiveMQTempTopicMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V9.ActiveMQTempTopicMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V9.ActiveMQTextMessageMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ActiveMQTextMessage
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V9.ActiveMQTextMessageMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V9.ActiveMQTextMessageMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V9.ActiveMQTopicMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ActiveMQTopic
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V9.ActiveMQTopicMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V9.ActiveMQTopicMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V9.BrokerIdMarshaller">
- <summary>
- Marshalling code for Open Wire Format for BrokerId
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V9.BrokerIdMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V9.BrokerIdMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V9.BrokerInfoMarshaller">
- <summary>
- Marshalling code for Open Wire Format for BrokerInfo
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V9.BrokerInfoMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V9.BrokerInfoMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V9.ConnectionControlMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ConnectionControl
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V9.ConnectionControlMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V9.ConnectionControlMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V9.ConnectionErrorMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ConnectionError
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V9.ConnectionErrorMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V9.ConnectionErrorMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V9.ConnectionIdMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ConnectionId
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V9.ConnectionIdMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V9.ConnectionIdMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V9.ConnectionInfoMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ConnectionInfo
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V9.ConnectionInfoMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V9.ConnectionInfoMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V9.ConsumerControlMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ConsumerControl
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V9.ConsumerControlMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V9.ConsumerControlMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V9.ConsumerIdMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ConsumerId
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V9.ConsumerIdMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V9.ConsumerIdMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V9.ConsumerInfoMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ConsumerInfo
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V9.ConsumerInfoMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V9.ConsumerInfoMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V9.ControlCommandMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ControlCommand
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V9.ControlCommandMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V9.ControlCommandMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V9.DataArrayResponseMarshaller">
- <summary>
- Marshalling code for Open Wire Format for DataArrayResponse
- </summary>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V9.ResponseMarshaller">
- <summary>
- Marshalling code for Open Wire Format for Response
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V9.ResponseMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V9.ResponseMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V9.DataArrayResponseMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V9.DataArrayResponseMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V9.DataResponseMarshaller">
- <summary>
- Marshalling code for Open Wire Format for DataResponse
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V9.DataResponseMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V9.DataResponseMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V9.DestinationInfoMarshaller">
- <summary>
- Marshalling code for Open Wire Format for DestinationInfo
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V9.DestinationInfoMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V9.DestinationInfoMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V9.DiscoveryEventMarshaller">
- <summary>
- Marshalling code for Open Wire Format for DiscoveryEvent
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V9.DiscoveryEventMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V9.DiscoveryEventMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V9.ExceptionResponseMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ExceptionResponse
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V9.ExceptionResponseMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V9.ExceptionResponseMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V9.FlushCommandMarshaller">
- <summary>
- Marshalling code for Open Wire Format for FlushCommand
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V9.FlushCommandMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V9.FlushCommandMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V9.IntegerResponseMarshaller">
- <summary>
- Marshalling code for Open Wire Format for IntegerResponse
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V9.IntegerResponseMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V9.IntegerResponseMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V9.JournalQueueAckMarshaller">
- <summary>
- Marshalling code for Open Wire Format for JournalQueueAck
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V9.JournalQueueAckMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V9.JournalQueueAckMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V9.JournalTopicAckMarshaller">
- <summary>
- Marshalling code for Open Wire Format for JournalTopicAck
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V9.JournalTopicAckMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V9.JournalTopicAckMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V9.JournalTraceMarshaller">
- <summary>
- Marshalling code for Open Wire Format for JournalTrace
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V9.JournalTraceMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V9.JournalTraceMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V9.JournalTransactionMarshaller">
- <summary>
- Marshalling code for Open Wire Format for JournalTransaction
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V9.JournalTransactionMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V9.JournalTransactionMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V9.KeepAliveInfoMarshaller">
- <summary>
- Marshalling code for Open Wire Format for KeepAliveInfo
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V9.KeepAliveInfoMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V9.KeepAliveInfoMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V9.LastPartialCommandMarshaller">
- <summary>
- Marshalling code for Open Wire Format for LastPartialCommand
- </summary>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V9.PartialCommandMarshaller">
- <summary>
- Marshalling code for Open Wire Format for PartialCommand
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V9.PartialCommandMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V9.PartialCommandMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V9.LastPartialCommandMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V9.LastPartialCommandMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V9.LocalTransactionIdMarshaller">
- <summary>
- Marshalling code for Open Wire Format for LocalTransactionId
- </summary>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V9.TransactionIdMarshaller">
- <summary>
- Marshalling code for Open Wire Format for TransactionId
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V9.LocalTransactionIdMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V9.LocalTransactionIdMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V9.MarshallerFactory">
- <summary>
- Used to create marshallers for a specific version of the OpenWire protocol.
- Each non-abstract DataStructure object has a registered Marshaller that is
- created and added to the OpenWireFormat objects format collection.
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V9.MarshallerFactory.configure(Apache.NMS.ActiveMQ.OpenWire.OpenWireFormat)">
- <summery>
- Adds the Marshallers for this version of the OpenWire protocol to the
- Collection of Marshallers stored in the OpenWireFormat class.
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V9.MessageAckMarshaller">
- <summary>
- Marshalling code for Open Wire Format for MessageAck
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V9.MessageAckMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V9.MessageAckMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V9.MessageDispatchMarshaller">
- <summary>
- Marshalling code for Open Wire Format for MessageDispatch
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V9.MessageDispatchMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V9.MessageDispatchMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V9.MessageDispatchNotificationMarshaller">
- <summary>
- Marshalling code for Open Wire Format for MessageDispatchNotification
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V9.MessageDispatchNotificationMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V9.MessageDispatchNotificationMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V9.MessageIdMarshaller">
- <summary>
- Marshalling code for Open Wire Format for MessageId
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V9.MessageIdMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V9.MessageIdMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V9.MessagePullMarshaller">
- <summary>
- Marshalling code for Open Wire Format for MessagePull
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V9.MessagePullMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V9.MessagePullMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V9.NetworkBridgeFilterMarshaller">
- <summary>
- Marshalling code for Open Wire Format for NetworkBridgeFilter
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V9.NetworkBridgeFilterMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V9.NetworkBridgeFilterMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V9.ProducerAckMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ProducerAck
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V9.ProducerAckMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V9.ProducerAckMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V9.ProducerIdMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ProducerId
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V9.ProducerIdMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V9.ProducerIdMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V9.ProducerInfoMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ProducerInfo
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V9.ProducerInfoMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V9.ProducerInfoMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V9.RemoveInfoMarshaller">
- <summary>
- Marshalling code for Open Wire Format for RemoveInfo
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V9.RemoveInfoMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V9.RemoveInfoMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V9.RemoveSubscriptionInfoMarshaller">
- <summary>
- Marshalling code for Open Wire Format for RemoveSubscriptionInfo
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V9.RemoveSubscriptionInfoMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V9.RemoveSubscriptionInfoMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V9.ReplayCommandMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ReplayCommand
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V9.ReplayCommandMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V9.ReplayCommandMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V9.SessionIdMarshaller">
- <summary>
- Marshalling code for Open Wire Format for SessionId
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V9.SessionIdMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V9.SessionIdMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V9.SessionInfoMarshaller">
- <summary>
- Marshalling code for Open Wire Format for SessionInfo
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V9.SessionInfoMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V9.SessionInfoMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V9.ShutdownInfoMarshaller">
- <summary>
- Marshalling code for Open Wire Format for ShutdownInfo
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V9.ShutdownInfoMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V9.ShutdownInfoMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V9.SubscriptionInfoMarshaller">
- <summary>
- Marshalling code for Open Wire Format for SubscriptionInfo
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V9.SubscriptionInfoMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V9.SubscriptionInfoMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V9.TransactionInfoMarshaller">
- <summary>
- Marshalling code for Open Wire Format for TransactionInfo
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V9.TransactionInfoMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V9.TransactionInfoMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V9.WireFormatInfoMarshaller">
- <summary>
- Marshalling code for Open Wire Format for WireFormatInfo
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V9.WireFormatInfoMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V9.WireFormatInfoMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.V9.XATransactionIdMarshaller">
- <summary>
- Marshalling code for Open Wire Format for XATransactionId
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V9.XATransactionIdMarshaller.CreateObject">
- <summery>
- Creates an instance of the Object that this marshaller handles.
- </summery>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.OpenWire.V9.XATransactionIdMarshaller.GetDataStructureType">
- <summery>
- Returns the type code for the Object that this Marshaller handles..
- </summery>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.BooleanStream">
- <summary>
- Represents a stream of boolean flags
- </summary>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.OpenWire.OpenWireFormat">
- <summary>
- Implements the <a href="http://activemq.apache.org/openwire.html">OpenWire</a> protocol.
- </summary>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.Transport.IWireFormat">
- <summary>
- Represents the marshalling of commands to and from an IO stream
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Transport.IWireFormat.Marshal(System.Object,System.IO.BinaryWriter)">
- <summary>
- Marshalls the given command object onto the stream
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Transport.IWireFormat.Unmarshal(System.IO.BinaryReader)">
- <summary>
- Unmarshalls the next command object from the stream
- </summary>
- </member>
- <member name="P:Apache.NMS.ActiveMQ.Transport.IWireFormat.Transport">
- <summary>
- Gets the Transport that own this WireFormat instnace.
- </summary>
- </member>
- <member name="P:Apache.NMS.ActiveMQ.Transport.IWireFormat.Version">
- <summary>
- Gets the current version of the protocol that this WireFormat instance
- supports
- </summary>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.State.ConnectionStateTracker">
- <summary>
- Tracks the state of a connection so a newly established transport can be
- re-initialized to the state that was tracked.
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.State.ConnectionStateTracker.Track(Apache.NMS.ActiveMQ.Commands.Command)">
- <summary>
- </summary>
- <param name="command"></param>
- <returns>null if the command is not state tracked.</returns>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.State.ConnectionStateTracker.DoRestoreSessions(Apache.NMS.ActiveMQ.Transport.ITransport,Apache.NMS.ActiveMQ.State.ConnectionState)">
- <summary>
- </summary>
- <param name="transport"></param>
- <param name="connectionState"></param>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.State.ConnectionStateTracker.DoRestoreConsumers(Apache.NMS.ActiveMQ.Transport.ITransport,Apache.NMS.ActiveMQ.State.SessionState)">
- <summary>
- </summary>
- <param name="transport"></param>
- <param name="sessionState"></param>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.State.ConnectionStateTracker.DoRestoreProducers(Apache.NMS.ActiveMQ.Transport.ITransport,Apache.NMS.ActiveMQ.State.SessionState)">
- <summary>
- </summary>
- <param name="transport"></param>
- <param name="sessionState"></param>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.State.ConnectionStateTracker.DoRestoreTempDestinations(Apache.NMS.ActiveMQ.Transport.ITransport,Apache.NMS.ActiveMQ.State.ConnectionState)">
- <summary>
- </summary>
- <param name="transport"></param>
- <param name="connectionState"></param>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.Threads.CompositeTask">
- <summary>
- A Composite task is one of N tasks that can be managed by a
- CompositTaskRunner instance. The CompositeTaskRunner checks each
- task when its wakeup method is called to determine if the Task has
- any work it needs to complete, if no tasks have any pending work
- then the CompositeTaskRunner can return to its sleep state until
- the next time its wakeup method is called or it is shut down.
- </summary>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.Threads.Task">
- <summary>
- Represents a task that may take a few iterations to complete.
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Threads.Task.Iterate">
- <summary>
- Performs some portion of the work that this Task object is
- assigned to complete. When the task is entirely finished this
- method should return false.
- </summary>
- <returns>
- A <see cref="T:System.Boolean"/> this indicates if this Task should
- be run again.
- </returns>
- </member>
- <member name="P:Apache.NMS.ActiveMQ.Threads.CompositeTask.IsPending">
- <summary>
- Indicates if this Task has any pending work.
- </summary>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.Threads.CompositeTaskRunner">
- <summary>
- A TaskRunner that dedicates a single thread to running a single Task.
- </summary>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.Threads.TaskRunner">
- <summary>
- Allows you to request a thread execute the associated Task.
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Threads.TaskRunner.Wakeup">
- <summary>
- Wakeup the TaskRunner and have it check for any pending work that
- needs to be completed. If none is found it will go back to sleep
- until another Wakeup call is made.
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Threads.TaskRunner.Shutdown">
- <summary>
- Attempt to Shutdown the TaskRunner, this method will wait indefinitely
- for the TaskRunner to quite if the task runner is in a call to its Task's
- run method and that never returns.
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Threads.TaskRunner.Shutdown(System.TimeSpan)">
- <summary>
- Performs a timed wait for the TaskRunner to shutdown. If the TaskRunner
- is in a call to its Task's run method and that does not return before the
- timeout expires this method returns and the TaskRunner may remain in the
- running state.
- </summary>
- <param name="timeout">
- A <see cref="T:System.TimeSpan"/>
- </param>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Threads.TaskRunner.ShutdownWithAbort(System.TimeSpan)">
- <summary>
- Performs a timed wait for the TaskRunner to shutdown. If the TaskRunner
- is in a call to its Task's run method and that does not return before the
- timeout expires this method sends an Abort to the Task thread and return.
- </summary>
- <param name="timeout">
- A <see cref="T:System.TimeSpan"/>
- </param>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.Threads.DedicatedTaskRunner">
- <summary>
- A TaskRunner that dedicates a single thread to running a single Task.
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Threads.PooledTaskRunner.Wakeup">
- <summary>
- We Expect MANY wakeup calls on the same TaskRunner.
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Threads.PooledTaskRunner.Shutdown(System.TimeSpan)">
- <summary>
- shut down the task
- </summary>
- <param name="timeout"></param>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.Threads.Scheduler">
- <summary>
- Scheduler Service useful for running various delayed units of work.
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Threads.Scheduler.ExecutePeriodically(System.Threading.WaitCallback,System.Object,System.Int32)">
- <summary>
- Executes the given task periodically using a fixed-delay execution style
- which prevents tasks from bunching should there be some delay such as
- garbage collection or machine sleep.
-
- This repeating unit of work can later be cancelled using the WaitCallback
- that was originally used to initiate the processing.
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Threads.Scheduler.ExecutePeriodically(System.Threading.WaitCallback,System.Object,System.TimeSpan)">
- <summary>
- Executes the given task periodically using a fixed-delay execution style
- which prevents tasks from bunching should there be some delay such as
- garbage collection or machine sleep.
-
- This repeating unit of work can later be cancelled using the WaitCallback
- that was originally used to initiate the processing.
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Threads.Scheduler.ExecuteAfterDelay(System.Threading.WaitCallback,System.Object,System.Int32)">
- <summary>
- Executes the given task the after delay, no reference is kept for this
- task so it cannot be cancelled later.
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Threads.Scheduler.ExecuteAfterDelay(System.Threading.WaitCallback,System.Object,System.TimeSpan)">
- <summary>
- Executes the given task the after delay, no reference is kept for this
- task so it cannot be cancelled later.
- </summary>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.Threads.TaskRunnerFactory">
- <summary>
- Manages the thread pool for long running tasks. Long running tasks are not
- always active but when they are active, they may need a few iterations of
- processing for them to become idle. The manager ensures that each task is
- processes but that no one task overtakes the system. This is kina like
- cooperative multitasking.
-
- If your OS/JVM combination has a good thread model, you may want to avoid
- using a thread pool to run tasks and use a DedicatedTaskRunner instead.
- </summary>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.Threads.ThreadPoolExecutor">
- <summary>
- This class provides a wrapper around the ThreadPool mechanism in .NET
- to allow for serial execution of jobs in the ThreadPool and provide
- a means of shutting down the execution of jobs in a deterministic
- way.
- </summary>
- </member>
- <member name="P:Apache.NMS.ActiveMQ.Threads.ThreadPoolExecutor.IsShutdown">
- <summary>
- Returns true if this ThreadPoolExecutor has been shut down but has not
- finished running all the tasks that have been Queue. When a ThreadPoolExecutor
- is shut down it will not accept any new tasks but it will complete all tasks
- that have been previously queued.
- </summary>
- </member>
- <member name="P:Apache.NMS.ActiveMQ.Threads.ThreadPoolExecutor.IsTerminated">
- <summary>
- Returns true if this ThreadPoolExecutor has been shut down and has also
- completed processing of all outstanding tasks in its task Queue.
- </summary>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.Threads.ThreadPoolExecutor.Future">
- <summary>
- Represents an asynchronous task that is executed on the ThreadPool
- at some point in the future.
- </summary>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.Threads.TimerEx">
- <summary>
- A facility for applications to schedule tasks for future execution in a background
- thread. Tasks may be scheduled for one-time execution, or for repeated execution at
- regular intervals. Unlike the normal .NET Timer this Timer allows for multiple tasks
- to be scheduled in a single Timer object.
-
- Corresponding to each Timer object is a single background thread that is used to execute
- all of the timer's tasks, sequentially. Timer tasks should complete quickly. If a timer
- task takes excessive time to complete, it "hogs" the timer's task execution thread. This
- can, in turn, delay the execution of subsequent tasks, which may "bunch up" and execute
- in rapid succession when (and if) the offending task finally completes.
-
- After the last live reference to a Timer object goes away and all outstanding tasks have
- completed execution, the timer's task execution thread terminates gracefully (and becomes
- subject to garbage collection). However, this can take arbitrarily long to occur. By default,
- the task execution thread does not run as a Background thread, so it is capable of keeping an
- application from terminating. If a caller wants to terminate a timer's task execution thread
- rapidly, the caller should invoke the timer's cancel method.
-
- If the timer's task execution thread terminates unexpectedly, any further attempt to schedule
- a task on the timer will result in an IllegalStateException, as if the timer's cancel method
- had been invoked.
-
- This class is thread-safe: multiple threads can share a single Timer object without the
- need for external synchronization.
-
- This class does not offer real-time guarantees: it schedules tasks using the
- EventWaitHandle.WaitOne(TimeSpan) method.
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Threads.TimerEx.Cancel">
- <summary>
- Terminates this timer, discarding any currently scheduled tasks. Does not interfere
- with a currently executing task (if it exists). Once a timer has been terminated,
- its execution thread terminates gracefully, and no more tasks may be scheduled on it.
-
- Note that calling this method from within the run method of a timer task that was
- invoked by this timer absolutely guarantees that the ongoing task execution is the
- last task execution that will ever be performed by this timer.
-
- This method may be called repeatedly; the second and subsequent calls have no effect.
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Threads.TimerEx.Purge">
- <summary>
- Removes all cancelled tasks from this timer's task queue. Calling this method has
- no effect on the behavior of the timer, but eliminates the references to the cancelled
- tasks from the queue. If there are no external references to these tasks, they become
- eligible for garbage collection.
-
- Most programs will have no need to call this method. It is designed for use by the
- rare application that cancels a large number of tasks. Calling this method trades
- time for space: the runtime of the method may be proportional to n + c log n, where
- n is the number of tasks in the queue and c is the number of cancelled tasks.
-
- Note that it is permissible to call this method from within a a task scheduled
- on this timer.
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Threads.TimerEx.Schedule(System.Threading.WaitCallback,System.Object,System.DateTime)">
- <summary>
- Schedules the specified WaitCallback task for execution at the specified time. If the
- time is in the past, the task is scheduled for immediate execution. The method returns
- a TimerTask instance that can be used to later cancel the scheduled task.
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Threads.TimerEx.Schedule(System.Threading.WaitCallback,System.Object,System.Int32)">
- <summary>
- Schedules the specified WaitCallback task for execution after the specified delay.
- The method returns a TimerTask instance that can be used to later cancel the
- scheduled task.
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Threads.TimerEx.Schedule(System.Threading.WaitCallback,System.Object,System.TimeSpan)">
- <summary>
- Schedules the specified WaitCallback task for execution after the specified delay.
- The method returns a TimerTask instance that can be used to later cancel the
- scheduled task.
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Threads.TimerEx.Schedule(System.Threading.WaitCallback,System.Object,System.Int32,System.Int32)">
- <summary>
- Schedules the specified WaitCallback task for repeated fixed-delay execution,
- beginning after the specified delay. Subsequent executions take place at approximately
- regular intervals separated by the specified period.
-
- In fixed-delay execution, each execution is scheduled relative to the actual execution
- time of the previous execution. If an execution is delayed for any reason (such as
- garbage collection or other background activity), subsequent executions will be delayed.
-
- Fixed-delay execution is appropriate for recurring activities that require "smoothness."
- In other words, it is appropriate for activities where it is more important to keep the
- frequency accurate in the short run than in the long run.
-
- The method returns a TimerTask instance that can be used to later cancel the
- scheduled task.
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Threads.TimerEx.Schedule(System.Threading.WaitCallback,System.Object,System.TimeSpan,System.TimeSpan)">
- <summary>
- Schedules the specified WaitCallback task for repeated fixed-delay execution,
- beginning after the specified delay. Subsequent executions take place at approximately
- regular intervals separated by the specified period.
-
- In fixed-delay execution, each execution is scheduled relative to the actual execution
- time of the previous execution. If an execution is delayed for any reason (such as
- garbage collection or other background activity), subsequent executions will be delayed.
-
- Fixed-delay execution is appropriate for recurring activities that require "smoothness."
- In other words, it is appropriate for activities where it is more important to keep the
- frequency accurate in the short run than in the long run.
-
- The method returns a TimerTask instance that can be used to later cancel the
- scheduled task.
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Threads.TimerEx.Schedule(System.Threading.WaitCallback,System.Object,System.DateTime,System.Int32)">
- <summary>
- Schedules the specified WaitCallback task for repeated fixed-delay execution,
- beginning at the specified start time. Subsequent executions take place at approximately
- regular intervals separated by the specified period.
-
- In fixed-delay execution, each execution is scheduled relative to the actual execution
- time of the previous execution. If an execution is delayed for any reason (such as
- garbage collection or other background activity), subsequent executions will be delayed.
-
- Fixed-delay execution is appropriate for recurring activities that require "smoothness."
- In other words, it is appropriate for activities where it is more important to keep the
- frequency accurate in the short run than in the long run.
-
- The method returns a TimerTask instance that can be used to later cancel the
- scheduled task.
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Threads.TimerEx.Schedule(System.Threading.WaitCallback,System.Object,System.DateTime,System.TimeSpan)">
- <summary>
- Schedules the specified WaitCallback task for repeated fixed-delay execution,
- beginning at the specified start time. Subsequent executions take place at approximately
- regular intervals separated by the specified period.
-
- In fixed-delay execution, each execution is scheduled relative to the actual execution
- time of the previous execution. If an execution is delayed for any reason (such as
- garbage collection or other background activity), subsequent executions will be delayed.
-
- Fixed-delay execution is appropriate for recurring activities that require "smoothness."
- In other words, it is appropriate for activities where it is more important to keep the
- frequency accurate in the short run than in the long run.
-
- The method returns a TimerTask instance that can be used to later cancel the
- scheduled task.
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Threads.TimerEx.ScheduleAtFixedRate(System.Threading.WaitCallback,System.Object,System.Int32,System.Int32)">
- <summary>
- Schedules the specified WaitCallback task for repeated fixed-rate execution, beginning
- after the specified delay. Subsequent executions take place at approximately regular
- intervals, separated by the specified period.
-
- In fixed-rate execution, each execution is scheduled relative to the scheduled execution
- time of the initial execution. If an execution is delayed for any reason (such as garbage
- collection or other background activity), two or more executions will occur in rapid
- succession to "catch up."
-
- Fixed-rate execution is appropriate for recurring activities that are sensitive to
- absolute time, such as ringing a chime every hour on the hour, or running scheduled
- maintenance every day at a particular time.
-
- The method returns a TimerTask instance that can be used to later cancel the
- scheduled task.
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Threads.TimerEx.ScheduleAtFixedRate(System.Threading.WaitCallback,System.Object,System.TimeSpan,System.TimeSpan)">
- <summary>
- Schedules the specified WaitCallback task for repeated fixed-rate execution, beginning
- after the specified delay. Subsequent executions take place at approximately regular
- intervals, separated by the specified period.
-
- In fixed-rate execution, each execution is scheduled relative to the scheduled execution
- time of the initial execution. If an execution is delayed for any reason (such as garbage
- collection or other background activity), two or more executions will occur in rapid
- succession to "catch up."
-
- Fixed-rate execution is appropriate for recurring activities that are sensitive to
- absolute time, such as ringing a chime every hour on the hour, or running scheduled
- maintenance every day at a particular time.
-
- The method returns a TimerTask instance that can be used to later cancel the
- scheduled task.
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Threads.TimerEx.ScheduleAtFixedRate(System.Threading.WaitCallback,System.Object,System.DateTime,System.Int32)">
- <summary>
- Schedules the specified WaitCallback task for repeated fixed-rate execution, beginning
- at the specified time. Subsequent executions take place at approximately regular
- intervals, separated by the specified period.
-
- In fixed-rate execution, each execution is scheduled relative to the scheduled execution
- time of the initial execution. If an execution is delayed for any reason (such as garbage
- collection or other background activity), two or more executions will occur in rapid
- succession to "catch up."
-
- Fixed-rate execution is appropriate for recurring activities that are sensitive to
- absolute time, such as ringing a chime every hour on the hour, or running scheduled
- maintenance every day at a particular time.
-
- The method returns a TimerTask instance that can be used to later cancel the
- scheduled task.
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Threads.TimerEx.ScheduleAtFixedRate(System.Threading.WaitCallback,System.Object,System.DateTime,System.TimeSpan)">
- <summary>
- Schedules the specified WaitCallback task for repeated fixed-rate execution, beginning
- at the specified time. Subsequent executions take place at approximately regular
- intervals, separated by the specified period.
-
- In fixed-rate execution, each execution is scheduled relative to the scheduled execution
- time of the initial execution. If an execution is delayed for any reason (such as garbage
- collection or other background activity), two or more executions will occur in rapid
- succession to "catch up."
-
- Fixed-rate execution is appropriate for recurring activities that are sensitive to
- absolute time, such as ringing a chime every hour on the hour, or running scheduled
- maintenance every day at a particular time.
-
- The method returns a TimerTask instance that can be used to later cancel the
- scheduled task.
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Threads.TimerEx.Schedule(Apache.NMS.ActiveMQ.Threads.TimerTask,System.DateTime)">
- <summary>
- Schedules the specified TimerTask for execution at the specified time. If the
- time is in the past.
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Threads.TimerEx.Schedule(Apache.NMS.ActiveMQ.Threads.TimerTask,System.Int32)">
- <summary>
- Schedules the specified TimerTask for execution after the specified delay.
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Threads.TimerEx.Schedule(Apache.NMS.ActiveMQ.Threads.TimerTask,System.TimeSpan)">
- <summary>
- Schedules the specified TimerTask for execution after the specified delay.
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Threads.TimerEx.Schedule(Apache.NMS.ActiveMQ.Threads.TimerTask,System.Int32,System.Int32)">
- <summary>
- Schedules the specified TimerTask for repeated fixed-delay execution, beginning
- after the specified delay. Subsequent executions take place at approximately
- regular intervals separated by the specified period.
-
- In fixed-delay execution, each execution is scheduled relative to the actual execution
- time of the previous execution. If an execution is delayed for any reason (such as
- garbage collection or other background activity), subsequent executions will be delayed.
-
- Fixed-delay execution is appropriate for recurring activities that require "smoothness."
- In other words, it is appropriate for activities where it is more important to keep the
- frequency accurate in the short run than in the long run.
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Threads.TimerEx.Schedule(Apache.NMS.ActiveMQ.Threads.TimerTask,System.TimeSpan,System.TimeSpan)">
- <summary>
- Schedules the specified TimerTask for repeated fixed-delay execution, beginning
- after the specified delay. Subsequent executions take place at approximately
- regular intervals separated by the specified period.
-
- In fixed-delay execution, each execution is scheduled relative to the actual execution
- time of the previous execution. If an execution is delayed for any reason (such as
- garbage collection or other background activity), subsequent executions will be delayed.
-
- Fixed-delay execution is appropriate for recurring activities that require "smoothness."
- In other words, it is appropriate for activities where it is more important to keep the
- frequency accurate in the short run than in the long run.
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Threads.TimerEx.Schedule(Apache.NMS.ActiveMQ.Threads.TimerTask,System.DateTime,System.Int32)">
- <summary>
- Schedules the specified TimerTask for repeated fixed-delay execution, beginning
- at the specified time. Subsequent executions take place at approximately
- regular intervals separated by the specified period.
-
- In fixed-delay execution, each execution is scheduled relative to the actual execution
- time of the previous execution. If an execution is delayed for any reason (such as
- garbage collection or other background activity), subsequent executions will be delayed.
-
- Fixed-delay execution is appropriate for recurring activities that require "smoothness."
- In other words, it is appropriate for activities where it is more important to keep the
- frequency accurate in the short run than in the long run.
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Threads.TimerEx.Schedule(Apache.NMS.ActiveMQ.Threads.TimerTask,System.DateTime,System.TimeSpan)">
- <summary>
- Schedules the specified TimerTask for repeated fixed-delay execution, beginning
- at the specified time. Subsequent executions take place at approximately
- regular intervals separated by the specified period.
-
- In fixed-delay execution, each execution is scheduled relative to the actual execution
- time of the previous execution. If an execution is delayed for any reason (such as
- garbage collection or other background activity), subsequent executions will be delayed.
-
- Fixed-delay execution is appropriate for recurring activities that require "smoothness."
- In other words, it is appropriate for activities where it is more important to keep the
- frequency accurate in the short run than in the long run.
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Threads.TimerEx.ScheduleAtFixedRate(Apache.NMS.ActiveMQ.Threads.TimerTask,System.Int32,System.Int32)">
- <summary>
- Schedules the specified TimerTask for repeated fixed-rate execution, beginning
- after the specified delay. Subsequent executions take place at approximately regular
- intervals, separated by the specified period.
-
- In fixed-rate execution, each execution is scheduled relative to the scheduled execution
- time of the initial execution. If an execution is delayed for any reason (such as garbage
- collection or other background activity), two or more executions will occur in rapid
- succession to "catch up."
-
- Fixed-rate execution is appropriate for recurring activities that are sensitive to
- absolute time, such as ringing a chime every hour on the hour, or running scheduled
- maintenance every day at a particular time.
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Threads.TimerEx.ScheduleAtFixedRate(Apache.NMS.ActiveMQ.Threads.TimerTask,System.TimeSpan,System.TimeSpan)">
- <summary>
- Schedules the specified TimerTask for repeated fixed-rate execution, beginning
- after the specified delay. Subsequent executions take place at approximately regular
- intervals, separated by the specified period.
-
- In fixed-rate execution, each execution is scheduled relative to the scheduled execution
- time of the initial execution. If an execution is delayed for any reason (such as garbage
- collection or other background activity), two or more executions will occur in rapid
- succession to "catch up."
-
- Fixed-rate execution is appropriate for recurring activities that are sensitive to
- absolute time, such as ringing a chime every hour on the hour, or running scheduled
- maintenance every day at a particular time.
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Threads.TimerEx.ScheduleAtFixedRate(Apache.NMS.ActiveMQ.Threads.TimerTask,System.DateTime,System.Int32)">
- <summary>
- Schedules the specified TimerTask for repeated fixed-rate execution, beginning
- at the specified time. Subsequent executions take place at approximately regular
- intervals, separated by the specified period.
-
- In fixed-rate execution, each execution is scheduled relative to the scheduled execution
- time of the initial execution. If an execution is delayed for any reason (such as garbage
- collection or other background activity), two or more executions will occur in rapid
- succession to "catch up."
-
- Fixed-rate execution is appropriate for recurring activities that are sensitive to
- absolute time, such as ringing a chime every hour on the hour, or running scheduled
- maintenance every day at a particular time.
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Threads.TimerEx.ScheduleAtFixedRate(Apache.NMS.ActiveMQ.Threads.TimerTask,System.DateTime,System.TimeSpan)">
- <summary>
- Schedules the specified TimerTask for repeated fixed-rate execution, beginning
- at the specified time. Subsequent executions take place at approximately regular
- intervals, separated by the specified period.
-
- In fixed-rate execution, each execution is scheduled relative to the scheduled execution
- time of the initial execution. If an execution is delayed for any reason (such as garbage
- collection or other background activity), two or more executions will occur in rapid
- succession to "catch up."
-
- Fixed-rate execution is appropriate for recurring activities that are sensitive to
- absolute time, such as ringing a chime every hour on the hour, or running scheduled
- maintenance every day at a particular time.
- </summary>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.Threads.TimerTask">
- <summary>
- A Task that is run in a Timer instance either once or repeatedly.
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Threads.TimerEx.TimerImpl.Run">
- <summary>
- Run this Timers event loop in its own Thread.
- </summary>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.Transactions.IRecoveryLogger">
- <summary>
- Interface for a Logger object used to store and retrieve Recovery
- Information needed to recover distributed transactions that operate
- in the Microsoft Distributed Transaction Context.
- </summary>
- </member>
- <member name="P:Apache.NMS.ActiveMQ.Transactions.RecoveryFileLogger.ResourceManagerId">
- <summary>
- The Unique Id of the Resource Manager that this logger is currently
- logging recovery information for.
- </summary>
- </member>
- <member name="P:Apache.NMS.ActiveMQ.Transactions.RecoveryFileLogger.Location">
- <summary>
- The Path to the location on disk where the recovery log is written
- to and read from.
- </summary>
- </member>
- <member name="P:Apache.NMS.ActiveMQ.Transactions.RecoveryFileLogger.AutoCreateLocation">
- <summary>
- Indiciate that the Logger should create and sibdirs of the
- given location that don't currently exist.
- </summary>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.Transactions.RecoveryLoggerFactoryAttribute">
- <summary>
- Attribute that decorates IRecoveryLoggerFactory implementations to allow
- the Recovery Policy to find all the available factories dynamically.
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Transport.Discovery.IDiscoveryAgent.RegisterService(System.String)">
- <summary>
- Registers the service with the given name.
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Transport.Discovery.IDiscoveryAgent.ServiceFailed(Apache.NMS.ActiveMQ.Commands.DiscoveryEvent)">
- <summary>
- A process actively using a service may see it go down before the DiscoveryAgent notices
- the service's failure. That process can use this method to notify the IDiscoveryAgent
- of the failure so that other listeners of this IDiscoveryAgent can also be made aware
- of the failure.
- </summary>
- </member>
- <member name="P:Apache.NMS.ActiveMQ.Transport.Discovery.IDiscoveryAgent.ServiceAdd">
- <summary>
- Gets or sets the service add event handler
- </summary>
- </member>
- <member name="P:Apache.NMS.ActiveMQ.Transport.Discovery.IDiscoveryAgent.ServiceRemove">
- <summary>
- Gets or sets the service remove event handler.
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Transport.Discovery.AbstractDiscoveryAgent.DoAdvertizeSelf">
- <summary>
- Overriden by the actual agent class to handle the publish of this service
- if supported by the agent.
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Transport.Discovery.AbstractDiscoveryAgent.DoStartAgent">
- <summary>
- Overriden by the agent class to handle starting any agent related services
- or opening resources needed for the agent.
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Transport.Discovery.AbstractDiscoveryAgent.DoStopAgent">
- <summary>
- Overriden by the agent to handle shutting down any agent created resources.
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Transport.Discovery.AbstractDiscoveryAgent.DoDiscovery">
- <summary>
- Called from the Agent background thread to allow the concrete agent implementation
- to perform its discovery of new services.
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Transport.Discovery.AbstractDiscoveryAgent.IsTimeForRecovery(Apache.NMS.ActiveMQ.Transport.Discovery.DiscoveredServiceData)">
- <summary>
- Returns true if this Broker has been marked as failed and it is now time to
- start a recovery attempt.
- </summary>
- </member>
- <member name="P:Apache.NMS.ActiveMQ.Transport.Discovery.AbstractDiscoveryAgent.KeepAliveInterval">
- <summary>
- Gets or sets the keep alive interval. This interval controls the amount
- of time that a service is kept before being considered idle and removed from
- the list of discovered services. This value is also used to control the
- period of time that this service will wait before advertising itself.
- </summary>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.ISuspendable">
- <summary>
- Optional interface for service type objects which support a
- logical suspend and resume mode. Services that can be suspended
- when not needed can reduce resource load.
- </summary>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.Transport.Discovery.IDiscoveryAgentFactory">
- <summary>
- Factory class interface for all DiscoveryAgent factories. Each agent factory
- should define its own factory attribute so that the agents can be found dynamically
- by the DiscoveryAgentFactory class.
- </summary>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.Transport.Discovery.ActiveMQDiscoveryAgentFactoryAttribute">
- <summary>
- Attribute that decorates DiscoveryAgentFactory implementations to allow
- the DiscoverAgentFactory to find all the available factories dynamically.
- </summary>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.Transport.Discovery.DiscoveredServiceData">
- <summary>
- Discovered service data event object. Used to contain information on the
- services that an agent discovers and track heartbeat and other service
- events used to determine if a service has failed or timed out due to a
- lack of recent reporting.
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Transport.Discovery.DiscoveryAgentFactory.CreateAgentFactory(System.Uri)">
- <summary>
- Create a DiscoveryAgent Factory for the scheme. If we do not support the agent protocol,
- an NMSConnectionException will be thrown.
- </summary>
- <param name="location"></param>
- <returns></returns>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.Transport.TransportFilter">
- <summary>
- Used to implement a filter on the transport layer.
- </summary>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.Transport.ITransport">
- <summary>
- Represents the logical networking transport layer. Transports implment the low
- level protocol specific portion of the Communication between the Client and a Broker
- such as TCP, UDP, etc. Transports make use of WireFormat objects to handle translateing
- the cononical OpenWire Commands used in this client into binary wire level packets that
- can be sent to the Broker or Service that the Transport connects to.
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Transport.ITransport.Oneway(Apache.NMS.ActiveMQ.Commands.Command)">
- <summary>
- Sends a Command object on the Wire but does not wait for any response from the
- receiver before returning.
- </summary>
- <param name="command">
- A <see cref="P:Apache.NMS.ActiveMQ.Transport.ITransport.Command"/>
- </param>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Transport.ITransport.AsyncRequest(Apache.NMS.ActiveMQ.Commands.Command)">
- <summary>
- Sends a Command object which requires a response from the Broker but does not
- wait for the response, instead a FutureResponse object is returned that the
- caller can use to wait on the Broker's response.
- </summary>
- <param name="command">
- A <see cref="P:Apache.NMS.ActiveMQ.Transport.ITransport.Command"/>
- </param>
- <returns>
- A <see cref="T:Apache.NMS.ActiveMQ.Transport.FutureResponse"/>
- </returns>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Transport.ITransport.Request(Apache.NMS.ActiveMQ.Commands.Command)">
- <summary>
- Sends a Command to the Broker and waits for a Response to that Command before
- returning, this version waits indefinitely for a response.
- </summary>
- <param name="command">
- A <see cref="P:Apache.NMS.ActiveMQ.Transport.ITransport.Command"/>
- </param>
- <returns>
- A <see cref="T:Apache.NMS.ActiveMQ.Commands.Response"/>
- </returns>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Transport.ITransport.Request(Apache.NMS.ActiveMQ.Commands.Command,System.TimeSpan)">
- <summary>
- Sends a Command to the Broker and waits for the given TimeSpan to expire for a
- response before returning.
- </summary>
- <param name="command">
- A <see cref="P:Apache.NMS.ActiveMQ.Transport.ITransport.Command"/>
- </param>
- <param name="timeout">
- A <see cref="T:System.TimeSpan"/>
- </param>
- <returns>
- A <see cref="T:Apache.NMS.ActiveMQ.Commands.Response"/>
- </returns>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Transport.ITransport.Narrow(System.Type)">
- <summary>
- Allows a caller to find a specific type of Transport in the Chain of
- Transports that is created. This allows a caller to find a specific
- object in the Transport chain and set or get properties on that specific
- instance. If the requested type isn't in the chain than Null is returned.
- </summary>
- <param name="type">
- A <see cref="T:System.Type"/>
- </param>
- <returns>
- A <see cref="T:System.Object"/>
- </returns>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Transport.ITransport.UpdateURIs(System.Boolean,System.Uri[])">
- <summary>
- Updates the Uri's that this Transport is aware of and will use to
- connect itself to. If the rebalance option is true this method will
- terminate any current connection and reconnect to another available
- Uri.
- </summary>
- <param name="rebalance">
- A <see cref="T:System.Boolean"/>
- </param>
- <param name="updatedURIs">
- A <see cref="T:System.Uri"/>
- </param>
- </member>
- <member name="P:Apache.NMS.ActiveMQ.Transport.ITransport.Timeout">
- <summary>
- Timeout in milliseconds to wait for sending synchronous messages or commands.
- Set to -1 for infinite timeout.
- </summary>
- </member>
- <member name="P:Apache.NMS.ActiveMQ.Transport.ITransport.AsyncTimeout">
- <summary>
- Timeout in milliseconds to wait for sending asynchronous messages or commands.
- Set to -1 for infinite timeout.
- </summary>
- </member>
- <member name="P:Apache.NMS.ActiveMQ.Transport.ITransport.IsDisposed">
- <value>
- Indicates if this Transport has already been disposed and can no longer
- be used.
- </value>
- </member>
- <member name="P:Apache.NMS.ActiveMQ.Transport.ITransport.IsFaultTolerant">
- <value>
- Indicates if this Transport is Fault Tolerant or not. A fault Tolerant
- Transport handles low level connection errors internally allowing a client
- to remain unaware of wire level disconnection and reconnection details.
- </value>
- </member>
- <member name="P:Apache.NMS.ActiveMQ.Transport.ITransport.IsConnected">
- <value>
- Indiciates if the Transport is current Connected to is assigned URI.
- </value>
- </member>
- <member name="P:Apache.NMS.ActiveMQ.Transport.ITransport.RemoteAddress">
- <value>
- The Remote Address that this transport is currently connected to.
- </value>
- </member>
- <member name="P:Apache.NMS.ActiveMQ.Transport.ITransport.IsReconnectSupported">
- <summary>
- Returns true if this Transport supports reconnections.
- </summary>
- </member>
- <member name="P:Apache.NMS.ActiveMQ.Transport.ITransport.IsUpdateURIsSupported">
- <summary>
- Returns true if this Transport can accept updated lists of connection Uri's.
- </summary>
- </member>
- <member name="P:Apache.NMS.ActiveMQ.Transport.ITransport.WireFormat">
- <summary>
- Returns the IWireFormat object that this transport uses to marshal and
- unmarshal Command objects.
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Transport.TransportFilter.Oneway(Apache.NMS.ActiveMQ.Commands.Command)">
- <summary>
- Method Oneway
- </summary>
- <param name="command">A Command</param>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Transport.TransportFilter.AsyncRequest(Apache.NMS.ActiveMQ.Commands.Command)">
- <summary>
- Method AsyncRequest
- </summary>
- <returns>A FutureResponse</returns>
- <param name="command">A Command</param>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Transport.TransportFilter.Request(Apache.NMS.ActiveMQ.Commands.Command)">
- <summary>
- Method Request
- </summary>
- <returns>A Response</returns>
- <param name="command">A Command</param>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Transport.TransportFilter.Request(Apache.NMS.ActiveMQ.Commands.Command,System.TimeSpan)">
- <summary>
- Method Request with time out for Response.
- </summary>
- <returns>A Response</returns>
- <param name="command">A Command</param>
- <param name="timeout">Timeout in milliseconds</param>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Transport.TransportFilter.Start">
- <summary>
- Method Start
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Transport.TransportFilter.Dispose">
- <summary>
- Method Dispose
- </summary>
- </member>
- <member name="P:Apache.NMS.ActiveMQ.Transport.TransportFilter.IsStarted">
- <summary>
- Property IsStarted
- </summary>
- </member>
- <member name="P:Apache.NMS.ActiveMQ.Transport.TransportFilter.Timeout">
- <summary>
- Timeout in milliseconds to wait for sending synchronous messages or commands.
- Set to -1 for infinite timeout.
- </summary>
- </member>
- <member name="P:Apache.NMS.ActiveMQ.Transport.TransportFilter.AsyncTimeout">
- <summary>
- Timeout in milliseconds to wait for sending asynchronous messages or commands.
- Set to -1 for infinite timeout.
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Transport.Discovery.DiscoveryTransport.ApplyParameters(System.Uri,System.Collections.Specialized.StringDictionary,System.String)">
- <summary>
- Given a Key / Value mapping create and append a URI query value that represents the mapped
- entries, return the newly updated URI that contains the value of the given URI and the
- appended query value. Each entry in the query string is prefixed by the supplied
- optionPrefix string.
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Transport.Failover.FailoverTransportFactory.CreateTransport(Apache.NMS.Util.URISupport.CompositeData)">
- <summary>
- Virtual transport create method which can be overriden by subclasses to provide
- an alternate FailoverTransport implementation. All transport creation methods in
- this factory calls through this method to create the ITransport instance so this
- is the only method that needs to be overriden.
- </summary>
- <param name="compositData"></param>
- <returns></returns>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Transport.Discovery.DiscoveryTransportFactory.CreateTransport(Apache.NMS.ActiveMQ.Transport.ICompositeTransport,Apache.NMS.Util.URISupport.CompositeData,System.Collections.Specialized.StringDictionary)">
- <summary>
- Factory method for creating a DiscoveryTransport. The Discovery Transport wraps the
- given ICompositeTransport and will add and remove Transport URIs as they are discovered.
- </summary>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.Transport.Failover.FailoverTransport">
- <summary>
- A Transport that is made reliable by being able to fail over to another
- transport when a transport failure is detected.
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Transport.ICompositeTransport.Add(System.Boolean,System.Uri[])">
- <summary>
- Adds a new set of Uris to the list of Uris that this Transport can connect to.
- </summary>
- <param name="rebalance">
- A <see cref="T:System.Boolean"/>
- Should the current connection be broken and a new one created.
- </param>
- <param name="uris">
- A <see cref="T:System.Uri"/>
- </param>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Transport.ICompositeTransport.Remove(System.Boolean,System.Uri[])">
- <summary>
- Remove the given Uris from this Transports list of known Uris.
- </summary>
- <param name="rebalance">
- A <see cref="T:System.Boolean"/>
- Should the current connection be broken and a new one created.
- </param>
- <param name="uris">
- A <see cref="T:System.Uri"/>
- </param>
- </member>
- <member name="P:Apache.NMS.ActiveMQ.Transport.Failover.FailoverTransport.AsyncConnect">
- <summary>
- Gets or sets a value indicating whether to asynchronously connect to sockets
- </summary>
- <value><c>true</c> if [async connect]; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:Apache.NMS.ActiveMQ.Transport.Failover.FailoverTransport.AsyncTimeout">
- <summary>
- If doing an asynchronous connect, the milliseconds before timing out if no connection can be made
- </summary>
- <value>The async timeout.</value>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.Transport.Mock.IResponseBuilder">
- <summary>
- Defines an Interface for a Command Response Builder used by the MockTransport
- to answer Commands sent via the Request and AsnycRequest methods.
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Transport.Mock.IResponseBuilder.BuildResponse(Apache.NMS.ActiveMQ.Commands.Command)">
- <summary>
- Given a Command, check if it requires a response and return the
- appropriate Response that the Broker would send for this Command
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Transport.Mock.IResponseBuilder.BuildIncomingCommands(Apache.NMS.ActiveMQ.Commands.Command)">
- <summary>
- When called the ResponseBuilder must construct all the Responses or
- Asynchronous commands that would be sent to this client by the Broker
- upon receipt of the passed command.
- </summary>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.Transport.Mock.MockTransport">
- <summary>
- Transport used for testing, mimics the behaviour of a normal Transport and allows
- messages to be sent and received
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Transport.Mock.MockTransport.InjectCommand(Apache.NMS.ActiveMQ.Commands.Command)">
- <summary>
- Injects a Command into the Transports inbound message queue, the Commands in the
- inbound Queue are dispatched to the registered CommnadHandler instance for
- processing, this simulates receiving a message from an external source, e.g.
- receiving a new message from the Broker.
- </summary>
- <param name="command">
- A <see cref="P:Apache.NMS.ActiveMQ.Transport.Mock.MockTransport.Command"/>
- </param>
- </member>
- <member name="P:Apache.NMS.ActiveMQ.Transport.Mock.MockTransport.Timeout">
- <summary>
- Timeout in milliseconds to wait for sending synchronous messages or commands.
- Set to -1 for infinite timeout.
- </summary>
- </member>
- <member name="P:Apache.NMS.ActiveMQ.Transport.Mock.MockTransport.AsyncTimeout">
- <summary>
- Timeout in milliseconds to wait for sending asynchronous messages or commands.
- Set to -1 for infinite timeout.
- </summary>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.Transport.Mock.MockTransportFactory">
- <summary>
- Factory class to create the MockTransport when given on a URI as mock://XXX
- </summary>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.Transport.Mock.OpenWireResponseBuilder">
- <summary>
- Builds responses using the internal Cononical OpenWire Commands format.
- </summary>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.Transport.Tcp.TcpTransport">
- <summary>
- An implementation of ITransport that uses sockets to communicate with the broker
- </summary>
- </member>
- <member name="F:Apache.NMS.ActiveMQ.Transport.Tcp.TcpTransport.receiveBufferSize">
- <summary>
- Size in bytes of the receive buffer.
- </summary>
- </member>
- <member name="F:Apache.NMS.ActiveMQ.Transport.Tcp.TcpTransport.sendBufferSize">
- <summary>
- Size in bytes of send buffer.
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Transport.Tcp.TcpTransport.Start">
- <summary>
- Method Start
- </summary>
- </member>
- <member name="P:Apache.NMS.ActiveMQ.Transport.Tcp.TcpTransport.IsStarted">
- <summary>
- Property IsStarted
- </summary>
- </member>
- <member name="P:Apache.NMS.ActiveMQ.Transport.Tcp.TcpTransport.Timeout">
- <summary>
- Timeout in milliseconds to wait for sending synchronous messages or commands.
- Set to -1 for infinite timeout.
- </summary>
- </member>
- <member name="P:Apache.NMS.ActiveMQ.Transport.Tcp.TcpTransport.AsyncTimeout">
- <summary>
- Timeout in milliseconds to wait for sending asynchronous messages or commands.
- Set to -1 for infinite timeout.
- </summary>
- </member>
- <member name="P:Apache.NMS.ActiveMQ.Transport.Tcp.SslTransport.ServerName">
- <summary>
- Indicates the name of the Server's Certificate. By default the Host name
- of the remote server is used, however if this doesn't match the name of the
- Server's certificate then this option can be set to override the default.
- </summary>
- </member>
- <member name="P:Apache.NMS.ActiveMQ.Transport.Tcp.SslTransport.ClientCertFilename">
- <summary>
- Indicates the location of the Client Certificate to use when the Broker
- is configured for Client Auth (not common). The SslTransport will supply
- this certificate to the SslStream via the SelectLocalCertificate method.
- </summary>
- </member>
- <member name="P:Apache.NMS.ActiveMQ.Transport.Tcp.SslTransport.ClientCertPassword">
- <summary>
- Password for the Client Certificate specified via configuration.
- </summary>
- </member>
- <member name="P:Apache.NMS.ActiveMQ.Transport.Tcp.SslTransport.AcceptInvalidBrokerCert">
- <summary>
- Indicates if the SslTransport should ignore any errors in the supplied Broker
- certificate and connect anyway, this is useful in testing with a default AMQ
- broker certificate that is self signed.
- </summary>
- </member>
- <member name="F:Apache.NMS.ActiveMQ.Transport.Tcp.TcpTransportFactory.useInactivityMonitor">
- <summary>
- Should the Inactivity Monitor be enabled on this Transport.
- </summary>
- </member>
- <member name="F:Apache.NMS.ActiveMQ.Transport.Tcp.TcpTransportFactory.receiveBufferSize">
- <summary>
- Size in bytes of the receive buffer.
- </summary>
- </member>
- <member name="F:Apache.NMS.ActiveMQ.Transport.Tcp.TcpTransportFactory.sendBufferSize">
- <summary>
- Size in bytes of send buffer.
- </summary>
- </member>
- <member name="F:Apache.NMS.ActiveMQ.Transport.Tcp.TcpTransportFactory.receiveTimeout">
- <summary>
- The time-out value, in milliseconds. The default value is 0, which indicates
- an infinite time-out period. Specifying -1 also indicates an infinite time-out period.
- </summary>
- </member>
- <member name="F:Apache.NMS.ActiveMQ.Transport.Tcp.TcpTransportFactory.sendTimeout">
- <summary>
- The time-out value, in milliseconds. If you set the property with a value between 1 and 499,
- the value will be changed to 500. The default value is 0, which indicates an infinite
- time-out period. Specifying -1 also indicates an infinite time-out period.
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Transport.Tcp.TcpTransportFactory.DoCreateTransport(System.Uri,System.Net.Sockets.Socket,Apache.NMS.ActiveMQ.Transport.IWireFormat)">
- <summary>
- Override in a subclass to create the specific type of transport that is
- being implemented.
- </summary>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.Transport.ActiveMQTransportFactoryAttribute">
- <summary>
- Attribute that decorates ITransportFactory implementations to allow
- the TransportFactory to find all the available factories dynamically.
- </summary>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.Transport.FutureResponse">
- <summary>
- Handles asynchronous responses
- </summary>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.Transport.InactivityMonitor">
- <summary>
- This class make sure that the connection is still alive,
- by monitoring the reception of commands from the peer of
- the transport.
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Transport.InactivityMonitor.#ctor(Apache.NMS.ActiveMQ.Transport.ITransport)">
- <summary>
- Constructor or the Inactivity Monitor
- </summary>
- <param name="next"></param>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Transport.InactivityMonitor.WriteCheck">
- <summary>
- Check the write to the broker
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Transport.InactivityMonitor.AllowReadCheck(System.TimeSpan)">
- <summary>
- Checks if we should allow the read check(if less than 90% of the read
- check time elapsed then we dont do the readcheck
- </summary>
- <param name="elapsed"></param>
- <returns></returns>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.Transport.LoggingTransport">
- <summary>
- A Transport filter that is used to log the commands sent and received.
- </summary>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.Transport.MutexTransport">
- <summary>
- A Transport which guards access to the next transport using a mutex.
- </summary>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.Transport.ResponseCorrelator">
- <summary>
- A Transport that correlates asynchronous send/receive messages into single request/response.
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Transport.TransportFactory.CreateTransport(System.Uri)">
- <summary>
- Creates a normal transport.
- </summary>
- <param name="location"></param>
- <returns>the transport</returns>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Transport.TransportFactory.CreateTransportFactory(System.Uri)">
- <summary>
- Create a transport factory for the scheme. If we do not support the transport protocol,
- an NMSConnectionException will be thrown.
- </summary>
- <param name="location"></param>
- <returns></returns>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.Transport.WireFormatNegotiator">
- <summary>
- A Transport which negotiates the wire format
- </summary>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.Util.BitArray">
- <summary>
- A specialized BitArray implementation that provides the smallest set
- of functionality needed for Message Auditing. This implementation is
- used over the .NET bit array to provide a small and more efficient
- BitArray that performs only the operations needed for Message Audit.
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Util.BitArray.Set(System.Int32,System.Boolean)">
- <summary>
- Sets the boolean value of the given bit in the array at the specified index.
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Util.BitArray.Get(System.Int32)">
- <summary>
- Get the boolean value contains in the BitArray at the given index
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Util.BitArray.Reset">
- <summary>
- Reset all the bits to zero or false.
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Util.BitArray.Reset(System.Int64)">
- <summary>
- Reset all the bits to the given value
- </summary>
- </member>
- <member name="P:Apache.NMS.ActiveMQ.Util.BitArray.Length">
- <summary>
- Returns the current length of the bits that have been
- set so far in this BitArray.
- </summary>
- </member>
- <member name="P:Apache.NMS.ActiveMQ.Util.BitArray.Bits">
- <summary>
- Returns the actual long value containing all the set bits.
- </summary>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.Util.BitArrayBin">
- <summary>
- Class used to hold BitArray objects for use in Message Audits.
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Util.BitArrayBin.IsInOrder(System.Int64)">
- <summary>
- Test if the next message is in order.
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Util.BitArrayBin.GetBit(System.Int64)">
- <summary>
- Get the boolean value at the index
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Util.BitArrayBin.GetBitArray(System.Int64)">
- <summary>
- Get the BitArray for the index
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Util.BitArrayBin.GetBin(System.Int64)">
- <summary>
- Get the index of the bin from the total index
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Util.BitArrayBin.GetOffset(System.Int64)">
- <summary>
- Get the offset into a bin from the total index
- </summary>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.Util.FifoMessageDispatchChannel">
- <summary>
- A FIFO based MessageDispatchChannel.
- </summary>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.Util.MessageDispatchChannel">
- <summary>
- Defines an interface for a Message Channel used to dispatch incoming
- Messages to a Session or MessageConsumer. The implementation controls
- how the messages are dequeued from the channel, one option is for a
- FIFO ordering while another might be to sort the Message's based on the
- set Message Priority.
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Util.IdGenerator.#ctor(System.String)">
- Construct an IdGenerator
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Util.IdGenerator.GenerateId">
- <summary>
- Generate a Unique Id
- </summary>
- <returns>
- A <see cref="T:System.String"/>
- </returns>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Util.IdGenerator.GenerateSanitizedId">
- <summary>
- Generate a unique ID - that is friendly for a URL or file system
- </summary>
- <returns>
- A <see cref="T:System.String"/>
- </returns>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Util.IdGenerator.GetSeedFromId(System.String)">
- <summary>
- From a generated id - return the seed (i.e. minus the count)
- </summary>
- <param name="id">
- A <see cref="T:System.String"/>
- </param>
- <returns>
- A <see cref="T:System.String"/>
- </returns>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Util.IdGenerator.GetSequenceFromId(System.String)">
- <summary>
- From a generated id - return the generator count
- </summary>
- <param name="id">
- A <see cref="T:System.String"/>
- </param>
- <returns>
- A <see cref="T:System.Int64"/>
- </returns>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Util.IdGenerator.Compare(System.String,System.String)">
- <summary>
- Does a proper compare on the ids
- </summary>
- <param name="id1">
- A <see cref="T:System.String"/>
- </param>
- <param name="id2">
- A <see cref="T:System.String"/>
- </param>
- <returns>
- A <see cref="T:System.Int32"/>
- </returns>
- </member>
- <member name="P:Apache.NMS.ActiveMQ.Util.IdGenerator.HostName">
- <summary>
- As we have to find the hostname as a side-affect of generating a unique
- stub, we allow it's easy retrevial here
- </summary>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.Util.IntrospectionSupport">
- <summary>
- Utility class used to provide conveince methods that apply named property
- settings to objects.
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Util.IntrospectionSupport.SetProperties(System.Object,System.Collections.Specialized.StringDictionary)">
- <summary>
- Sets the public properties of a target object using a string map.
- This method uses .Net reflection to identify public properties of
- the target object matching the keys from the passed map.
- </summary>
- <param name="target">The object whose properties will be set.</param>
- <param name="map">Map of key/value pairs.</param>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Util.IntrospectionSupport.SetProperties(System.Object,System.Collections.Specialized.StringDictionary,System.String)">
- <summary>
- Sets the public properties of a target object using a string map.
- This method uses .Net reflection to identify public properties of
- the target object matching the keys from the passed map.
- </summary>
- <param name="target">The object whose properties will be set.</param>
- <param name="map">Map of key/value pairs.</param>
- <param name="prefix">Key value prefix. This is prepended to the property name
- before searching for a matching key value.</param>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.Util.LRUCache`2">
- <summary>
- Implements the basic IDictionary interface and adds functionality for controlling
- the maximum number of entries that can be contained in the Map. When the maximum
- value is reached the oldest entry is removed so that the max size is never exceeded.
- </summary>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.Util.MemoryUsage">
- <summary>
- Utility class for Tracking Memory Usage with an imposed limit on the amount
- available. Provides methods for objects to wait on more space to become
- available if the memory limit is reached.
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Util.MemoryUsage.WaitForSpace">
- <summary>
- If no space is available then this method blocks until more becomes available.
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Util.MemoryUsage.WaitForSpace(System.TimeSpan)">
- <summary>
- If no space is available then this method blocks until more becomes available
- or until the specified timeout expires.
- </summary>
- <param name="timeout">
- A <see cref="T:System.TimeSpan"/>
- </param>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Util.MemoryUsage.EnqueueUsage(System.Int64)">
- <summary>
- Attempts to increase the amount of Memory Used, if non is available to fill
- then this method blocks until more is freed.
- </summary>
- <param name="usage">
- A <see cref="T:System.Int64"/>
- </param>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Util.MemoryUsage.IncreaseUsage(System.Int64)">
- <summary>
- Increase the level of Usage.
- </summary>
- <param name="value">
- A <see cref="T:System.Int64"/>
- </param>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Util.MemoryUsage.DecreaseUsage(System.Int64)">
- <summary>
- Decrease the level of Usage.
- </summary>
- <param name="value">
- A <see cref="T:System.Int64"/>
- </param>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Util.MemoryUsage.IsFull">
- <summary>
- Checks if the Usage Windows has become full, is so returns true
- otherwise returns false.
- </summary>
- <returns>
- A <see cref="T:System.Boolean"/>
- </returns>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.Util.ServiceStopper">
- <summary>
- Simple IStoppable service stopper class. Can be used to Stop multiple
- IStoppable instances without throwing an exception. Once all services
- have been stopped, the first thrown exception can be fired.
- </summary>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.AdvisoryConsumer">
- <summary>
- Consumes Advisory Messages for Temp Destination creation on deletion so that
- the connection can track valid destinations for its sessions, and session resources.
- </summary>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.IDispatcher">
- <summary>
- Interface that provides for a Class to provide dispatching service for
- an OpenWire MessageDispatch command.
- </summary>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.BrokerException">
- <summary>
- Exception thrown when the broker returns an error
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.BrokerException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Initializes a new instance of the BrokerException class with serialized data.
- Throws System.ArgumentNullException if the info parameter is null.
- Throws System.Runtime.Serialization.SerializationException if the class name is null or System.Exception.HResult is zero (0).
- </summary>
- <param name="info">The SerializationInfo that holds the serialized object data about the exception being thrown.</param>
- <param name="context">The StreamingContext that contains contextual information about the source or destination.</param>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.BrokerException.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- When overridden in a derived class, sets the SerializationInfo
- with information about the exception.
- </summary>
- <param name="info">The SerializationInfo that holds the serialized object data about the exception being thrown.</param>
- <param name="context">The StreamingContext that contains contextual information about the source or destination.</param>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.BrokerException.StackTraceDump(Apache.NMS.ActiveMQ.Commands.StackTraceElement[])">
- <summary>
- Generates a nice textual stack trace
- </summary>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.CompressionPolicy">
- <summary>
- Default Compression policy for NMS.ActiveMQ uses the built in GZipStream
- to compress and decompress the message body. This is not compatible with
- compression used by ActiveMQ so users should use this with caution.
- </summary>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.ICompressionPolicy">
- <summary>
- Policy interface for Message Compression, the policy should return
- a new Stream for compression or decompression upon request that wraps
- the provided Stream instance.
- </summary>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.Connection">
- <summary>
- Represents a connection with a message broker
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Connection.Start">
- <summary>
- Starts asynchronous message delivery of incoming messages for this connection.
- Synchronous delivery is unaffected.
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Connection.Stop">
- <summary>
- Temporarily stop asynchronous delivery of inbound messages for this connection.
- The sending of outbound messages is unaffected.
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Connection.CreateSession">
- <summary>
- Creates a new session to work on this connection
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Connection.CreateSession(Apache.NMS.AcknowledgementMode)">
- <summary>
- Creates a new session to work on this connection
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Connection.SyncRequest(Apache.NMS.ActiveMQ.Commands.Command)">
- <summary>
- Performs a synchronous request-response with the broker
- </summary>
-
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Connection.SyncRequest(Apache.NMS.ActiveMQ.Commands.Command,System.TimeSpan)">
- <summary>
- Performs a synchronous request-response with the broker for requested timeout duration.
- </summary>
- <param name="command"></param>
- <param name="requestTimeout"></param>
- <returns></returns>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Connection.CheckConnected">
- <summary>
- Check and ensure that the connection object is connected. If it is not
- connected or is closed or closing, a ConnectionClosedException is thrown.
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Connection.OnCommand(Apache.NMS.ActiveMQ.Transport.ITransport,Apache.NMS.ActiveMQ.Commands.Command)">
- <summary>
- Handle incoming commands
- </summary>
- <param name="commandTransport">An ITransport</param>
- <param name="command">A Command</param>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Connection.CreateLocalTransactionId">
- <summary>
- Creates a new local transaction ID
- </summary>
- </member>
- <member name="E:Apache.NMS.ActiveMQ.Connection.ExceptionListener">
- <summary>
- A delegate that can receive transport level exceptions.
- </summary>
- </member>
- <member name="E:Apache.NMS.ActiveMQ.Connection.ConnectionInterruptedListener">
- <summary>
- An asynchronous listener that is notified when a Fault tolerant connection
- has been interrupted.
- </summary>
- </member>
- <member name="E:Apache.NMS.ActiveMQ.Connection.ConnectionResumedListener">
- <summary>
- An asynchronous listener that is notified when a Fault tolerant connection
- has been resumed.
- </summary>
- </member>
- <member name="P:Apache.NMS.ActiveMQ.Connection.ProtocolVersion">
- <summary>
- This property indicates what version of the Protocol we are using to
- communicate with the Broker, if not set we return the lowest version
- number to indicate we support only the basic command set.
- </summary>
- </member>
- <member name="P:Apache.NMS.ActiveMQ.Connection.AsyncSend">
- <summary>
- This property indicates whether or not async send is enabled.
- </summary>
- </member>
- <member name="P:Apache.NMS.ActiveMQ.Connection.AsyncClose">
- <summary>
- This property indicates whether or not async close is enabled.
- When the connection is closed, it will either send a synchronous
- DisposeOf command to the broker and wait for confirmation (if true),
- or it will send the DisposeOf command asynchronously.
- </summary>
- </member>
- <member name="P:Apache.NMS.ActiveMQ.Connection.SendAcksAsync">
- <summary>
- This property indicates whether or not async sends are used for
- message acknowledgement messages. Sending Acks async can improve
- performance but may decrease reliability.
- </summary>
- </member>
- <member name="P:Apache.NMS.ActiveMQ.Connection.AckMode">
- <summary>
- This property sets the acknowledgment mode for the connection.
- The URI parameter connection.ackmode can be set to a string value
- that maps to the enumeration value.
- </summary>
- </member>
- <member name="P:Apache.NMS.ActiveMQ.Connection.ProducerWindowSize">
- <summary>
- This property is the maximum number of bytes in memory that a producer will transmit
- to a broker before waiting for acknowledgement messages from the broker that it has
- accepted the previously sent messages. In other words, this how you configure the
- producer flow control window that is used for async sends where the client is responsible
- for managing memory usage. The default value of 0 means no flow control at the client
- </summary>
- </member>
- <member name="P:Apache.NMS.ActiveMQ.Connection.AlwaysSyncSend">
- <summary>
- This property forces all messages that are sent to be sent synchronously overriding
- any usage of the AsyncSend flag. This can reduce performance in some cases since the
- only messages we normally send synchronously are Persistent messages not sent in a
- transaction. This options guarantees that no send will return until the broker has
- acknowledge receipt of the message
- </summary>
- </member>
- <member name="P:Apache.NMS.ActiveMQ.Connection.CopyMessageOnSend">
- <summary>
- This property indicates whether Message's should be copied before being sent via
- one of the Connection's send methods. Copying the Message object allows the user
- to resuse the Object over for another send. If the message isn't copied performance
- can improve but the user must not reuse the Object as it may not have been sent
- before they reset its payload.
- </summary>
- </member>
- <member name="P:Apache.NMS.ActiveMQ.Connection.UseCompression">
- <summary>
- Enable or Disable the use of Compression on Message bodies. When enabled all
- messages have their body compressed using the Deflate compression algorithm.
- The recipient of the message must support the use of message compression as well
- otherwise the receiving client will receive a message whose body appears in the
- compressed form.
- </summary>
- </member>
- <member name="P:Apache.NMS.ActiveMQ.Connection.MessagePrioritySupported">
- <summary>
- Indicate whether or not the resources of this Connection should support the
- Message Priority value of incoming messages and dispatch them accordingly.
- When disabled Message are always dispatched to Consumers in FIFO order.
- </summary>
- </member>
- <member name="P:Apache.NMS.ActiveMQ.Connection.DispatchAsync">
- <summary>
- synchronously or asynchronously by the broker.
- </summary>
- </member>
- <member name="P:Apache.NMS.ActiveMQ.Connection.DefaultClientId">
- <summary>
- The Default Client Id used if the ClientId property is not set explicity.
- </summary>
- </member>
- <member name="P:Apache.NMS.ActiveMQ.Connection.RedeliveryPolicy">
- <summary>
- Get/or set the redelivery policy for this connection.
- </summary>
- </member>
- <member name="P:Apache.NMS.ActiveMQ.Connection.IsStarted">
- <summary>
- This property determines if the asynchronous message delivery of incoming
- messages has been started for this connection.
- </summary>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.ConnectionClosedException">
- <summary>
- Exception thrown when a connection is used that it already closed
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.ConnectionClosedException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Initializes a new instance of the ConnectionClosedException class with serialized data.
- Throws System.ArgumentNullException if the info parameter is null.
- Throws System.Runtime.Serialization.SerializationException if the class name is null or System.Exception.HResult is zero (0).
- </summary>
- <param name="info">The SerializationInfo that holds the serialized object data about the exception being thrown.</param>
- <param name="context">The StreamingContext that contains contextual information about the source or destination.</param>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.ConnectionFactory">
- <summary>
- Represents a connection with a message broker
- </summary>
- </member>
- <member name="P:Apache.NMS.ActiveMQ.ConnectionFactory.BrokerUri">
- <summary>
- Get/or set the broker Uri.
- </summary>
- </member>
- <member name="P:Apache.NMS.ActiveMQ.ConnectionFactory.ConsumerTransformer">
- <summary>
- A Delegate that is called each time a Message is dispatched to allow the client to do
- any necessary transformations on the received message before it is delivered. The
- ConnectionFactory sets the provided delegate instance on each Connection instance that
- is created from this factory, each connection in turn passes the delegate along to each
- Session it creates which then passes that along to the Consumers it creates.
- </summary>
- </member>
- <member name="P:Apache.NMS.ActiveMQ.ConnectionFactory.ProducerTransformer">
- <summary>
- A delegate that is called each time a Message is sent from this Producer which allows
- the application to perform any needed transformations on the Message before it is sent.
- The ConnectionFactory sets the provided delegate instance on each Connection instance that
- is created from this factory, each connection in turn passes the delegate along to each
- Session it creates which then passes that along to the Producers it creates.
- </summary>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.ConnectionFailedException">
- <summary>
- Exception thrown when a connection is used that it has failed in some way.
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.ConnectionFailedException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Initializes a new instance of the ConnectionFailedException class with serialized data.
- Throws System.ArgumentNullException if the info parameter is null.
- Throws System.Runtime.Serialization.SerializationException if the class name is null or System.Exception.HResult is zero (0).
- </summary>
- <param name="info">The SerializationInfo that holds the serialized object data about the exception being thrown.</param>
- <param name="context">The StreamingContext that contains contextual information about the source or destination.</param>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.ConnectionMetaData">
- <summary>
- Implements the Connection Meta-Data feature for Apache.NMS.ActiveMQ
- </summary>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.ConsumerClosedException">
- <summary>
- Exception thrown when a consumer is used that it already closed
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.ConsumerClosedException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Initializes a new instance of the ConsumerClosedException class with serialized data.
- Throws System.ArgumentNullException if the info parameter is null.
- Throws System.Runtime.Serialization.SerializationException if the class name is null or System.Exception.HResult is zero (0).
- </summary>
- <param name="info">The SerializationInfo that holds the serialized object data about the exception being thrown.</param>
- <param name="context">The StreamingContext that contains contextual information about the source or destination.</param>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.DestinationFilter">
- <summary>
- Summary description for DestinationFilter.
- </summary>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.IOException">
- <summary>
- Exception thrown when an IO error occurs
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.ISynchronization.BeforeEnd">
- <summary>
- Called before a commit or rollback is applied.
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.ISynchronization.AfterCommit">
- <summary>
- Called after a commit
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.ISynchronization.AfterRollback">
- <summary>
- Called after a transaction rollback
- </summary>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.MessageConsumer">
- <summary>
- An object capable of receiving messages from some destination
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.MessageConsumer.Shutdown">
- <summary>
- Called from the parent Session of this Consumer to indicate that its
- parent session is closing and this Consumer should close down but not
- send any message to the Broker as the parent close will take care of
- removing its child resources at the broker.
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.MessageConsumer.Dequeue(System.TimeSpan)">
- <summary>
- Used to get an enqueued message from the unconsumedMessages list. The
- amount of time this method blocks is based on the timeout value. if
- timeout == Timeout.Infinite then it blocks until a message is received.
- if timeout == 0 then it it tries to not block at all, it returns a
- message if it is available if timeout > 0 then it blocks up to timeout
- amount of time. Expired messages will consumed by this method.
- </summary>
- <param name="timeout">
- A <see cref="T:System.TimeSpan"/>
- </param>
- <returns>
- A <see cref="T:Apache.NMS.ActiveMQ.Commands.MessageDispatch"/>
- </returns>
- </member>
- <member name="P:Apache.NMS.ActiveMQ.MessageConsumer.ConsumerTransformer">
- <summary>
- A Delegate that is called each time a Message is dispatched to allow the client to do
- any necessary transformations on the received message before it is delivered.
- </summary>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.MessageProducer">
- <summary>
- An object capable of sending messages to some destination
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.MessageProducer.Shutdown">
- <summary>
- Called from the Parent session to deactivate this Producer, when a parent
- is closed all children are automatically removed from the broker so this
- method circumvents the need to send a Remove command to the broker.
- </summary>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.NetTxConnection">
- <summary>
- Extends the basic Connection class to provide a transacted Connection
- instance that operates within the bounds of a .NET Scoped Transaction.
-
- The default Session creation methods of Connection are overriden here
- to always return a TX capable session instance.
- </summary>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.NetTxRecoveryPolicy">
- <summary>
- Policy class used to configure the options associated with TX
- recovery.
- </summary>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.Session">
- <summary>
- Default provider of ISession
- </summary>
- </member>
- <member name="F:Apache.NMS.ActiveMQ.Session.myLock">
- <summary>
- Private object used for synchronization, instead of public "this"
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Session.DeleteDestination(Apache.NMS.IDestination)">
- <summary>
- Delete a destination (Queue, Topic, Temp Queue, Temp Topic).
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Session.DoStartTransaction">
- <summary>
- Ensures that a transaction is started
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.Session.DoNothingAcknowledge(Apache.NMS.ActiveMQ.Commands.ActiveMQMessage)">
- <summary>
- Prevents message from throwing an exception if a client calls Acknoweldge on
- a message that is part of a transaction either being produced or consumed. The
- JMS Spec indicates that users should be able to call Acknowledge with no effect
- if the message is in a transaction.
- </summary>
- <param name="message">
- A <see cref="T:Apache.NMS.ActiveMQ.Commands.ActiveMQMessage"/>
- </param>
- </member>
- <member name="P:Apache.NMS.ActiveMQ.Session.MaximumPendingMessageLimit">
- <summary>
- Sets the maximum number of messages to keep around per consumer
- in addition to the prefetch window for non-durable topics until messages
- will start to be evicted for slow consumers.
- Must be > 0 to enable this feature
- </summary>
- </member>
- <member name="P:Apache.NMS.ActiveMQ.Session.DispatchAsync">
- <summary>
- Enables or disables whether asynchronous dispatch should be used by the broker
- </summary>
- </member>
- <member name="P:Apache.NMS.ActiveMQ.Session.Exclusive">
- <summary>
- Enables or disables exclusive consumers when using queues. An exclusive consumer means
- only one instance of a consumer is allowed to process messages on a queue to preserve order
- </summary>
- </member>
- <member name="P:Apache.NMS.ActiveMQ.Session.Retroactive">
- <summary>
- Enables or disables retroactive mode for consumers; i.e. do they go back in time or not?
- </summary>
- </member>
- <member name="P:Apache.NMS.ActiveMQ.Session.Priority">
- <summary>
- Sets the default consumer priority for consumers
- </summary>
- </member>
- <member name="P:Apache.NMS.ActiveMQ.Session.ConsumerTransformer">
- <summary>
- A Delegate that is called each time a Message is dispatched to allow the client to do
- any necessary transformations on the received message before it is delivered.
- The Session instance sets the delegate on each Consumer it creates.
- </summary>
- </member>
- <member name="P:Apache.NMS.ActiveMQ.Session.ProducerTransformer">
- <summary>
- A delegate that is called each time a Message is sent from this Producer which allows
- the application to perform any needed transformations on the Message before it is sent.
- The Session instance sets the delegate on each Producer it creates.
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.NetTxSession.Enlist(System.Transactions.Transaction)">
- <summary>
- Manually Enlists in the given Transaction. This can be used to when the
- client is using the Session in Asynchronous listener mode since the Session
- cannot atuomatically join in this case as there is no Ambient transaction in
- the Message Dispatch thread. This also allows for clients to use the explicit
- exception model when necessary.
- </summary>
- </member>
- <member name="P:Apache.NMS.ActiveMQ.NetTxSession.IsTransacted">
- <summary>
- Reports Transacted whenever there is an Ambient Transaction or the internal
- TransactionContext is still involed in a .NET Transaction beyond the lifetime
- of an ambient transaction (can happen during a scoped transaction disposing
- without Complete being called and a Rollback is in progress.)
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.NetTxTransactionContext.ResetDtcRecovery">
- <summary>
- DTC recovery is performed once for each AppDomain per default. In case you want to perform
- it again during execution of the application you can call this method before.
- But ensure in this case that no connection is active anymore.
- </summary>
- </member>
- <member name="M:Apache.NMS.ActiveMQ.NetTxTransactionContext.InitializeDtcTxContext">
- <summary>
- Should be called from NetTxSession when created to check if any TX
- data is stored for recovery and whether the Broker has matching info
- stored. If an Transaction is found that belongs to this client and is
- still alive on the Broker it will be recovered, otherwise the stored
- data should be cleared.
- </summary>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.PrefetchPolicy">
- <summary>
- Class used to define the various limits that should be used for the Prefetch
- limit on destination based on the type of Destination in use.
- </summary>
- </member>
- <member name="T:Apache.NMS.ActiveMQ.RequestTimedOutException">
- <summary>
- Exception thrown when an Request times out.
- </summary>
- </member>
- </members>
-</doc>
diff --git a/SallyConnect/bin/Debug/Apache.NMS.Stomp.dll b/SallyConnect/bin/Debug/Apache.NMS.Stomp.dll
deleted file mode 100644
index 6f4421468fb758c9aa44ab9025a338459c4db423..0000000000000000000000000000000000000000
Binary files a/SallyConnect/bin/Debug/Apache.NMS.Stomp.dll and /dev/null differ
diff --git a/SallyConnect/bin/Debug/Apache.NMS.Stomp.pdb b/SallyConnect/bin/Debug/Apache.NMS.Stomp.pdb
deleted file mode 100644
index 6942e2e117aaa8cdebeefbfe79e4eddf0a5134d1..0000000000000000000000000000000000000000
Binary files a/SallyConnect/bin/Debug/Apache.NMS.Stomp.pdb and /dev/null differ
diff --git a/SallyConnect/bin/Debug/Apache.NMS.Stomp.xml b/SallyConnect/bin/Debug/Apache.NMS.Stomp.xml
deleted file mode 100644
index ee117faa0487e8dd1b1b460d395f13b0fc004314..0000000000000000000000000000000000000000
--- a/SallyConnect/bin/Debug/Apache.NMS.Stomp.xml
+++ /dev/null
@@ -1,1517 +0,0 @@
-<?xml version="1.0"?>
-<doc>
- <assembly>
- <name>Apache.NMS.Stomp</name>
- </assembly>
- <members>
- <member name="T:Apache.NMS.Stomp.Commands.BaseDataStructure">
- <summary>
- Base class for all DataStructure implementations
- </summary>
- </member>
- <member name="T:Apache.NMS.Stomp.Commands.DataStructure">
- <summary>
- An OpenWire command
- </summary>
- </member>
- <member name="T:Apache.NMS.Stomp.Commands.Command">
- <summary>
- An Stomp command
- </summary>
- </member>
- <member name="T:Apache.NMS.Stomp.Commands.MarshallAware">
- <summary>
- Represents a marshallable entity
- </summary>
- </member>
- <member name="M:Apache.NMS.Stomp.Commands.BaseMessage.Clone">
-
- <summery>
- Clone this object and return a new instance that the caller now owns.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.Stomp.Commands.BaseMessage.ToString">
-
- <summery>
- Returns a string containing the information for this DataStructure
- such as its type and value of its elements.
- </summery>
-
- </member>
- <member name="P:Apache.NMS.Stomp.Commands.BaseMessage.IsMessage">
-
- <summery>
- Return an answer of true to the isMessage() query.
- </summery>
-
- </member>
- <member name="T:Apache.NMS.Stomp.Commands.BrokerError">
- <summary>
- Represents an exception on the broker
- </summary>
- </member>
- <member name="P:Apache.NMS.Stomp.Commands.Message.NMSCorrelationID">
- <summary>
- The correlation ID used to correlate messages with conversations or long running business processes
- </summary>
- </member>
- <member name="P:Apache.NMS.Stomp.Commands.Message.NMSDestination">
- <summary>
- The destination of the message
- </summary>
- </member>
- <member name="P:Apache.NMS.Stomp.Commands.Message.NMSTimeToLive">
- <summary>
- The time in milliseconds that this message should expire in
- </summary>
- </member>
- <member name="P:Apache.NMS.Stomp.Commands.Message.NMSTimestamp">
- <summary>
- The timestamp the broker added to the message
- </summary>
- </member>
- <member name="P:Apache.NMS.Stomp.Commands.Message.NMSMessageId">
- <summary>
- The message ID which is set by the provider
- </summary>
- </member>
- <member name="P:Apache.NMS.Stomp.Commands.Message.NMSDeliveryMode">
- <summary>
- Whether or not this message is persistent
- </summary>
- </member>
- <member name="P:Apache.NMS.Stomp.Commands.Message.NMSPriority">
- <summary>
- The Priority on this message
- </summary>
- </member>
- <member name="P:Apache.NMS.Stomp.Commands.Message.NMSRedelivered">
- <summary>
- Returns true if this message has been redelivered to this or another consumer before being acknowledged successfully.
- </summary>
- </member>
- <member name="P:Apache.NMS.Stomp.Commands.Message.NMSReplyTo">
- <summary>
- The destination that the consumer of this message should send replies to
- </summary>
- </member>
- <member name="P:Apache.NMS.Stomp.Commands.Message.NMSType">
- <summary>
- The type name of this message
- </summary>
- </member>
- <member name="P:Apache.NMS.Stomp.Commands.Message.NMSXDeliveryCount">
- <summary>
- Returns the number of times this message has been redelivered to other consumers without being acknowledged successfully.
- </summary>
- </member>
- <member name="P:Apache.NMS.Stomp.Commands.Message.NMSXGroupID">
- <summary>
- The Message Group ID used to group messages together to the same consumer for the same group ID value
- </summary>
- </member>
- <member name="P:Apache.NMS.Stomp.Commands.Message.NMSXGroupSeq">
- <summary>
- The Message Group Sequence counter to indicate the position in a group
- </summary>
- </member>
- <member name="P:Apache.NMS.Stomp.Commands.Message.NMSXProducerTXID">
- <summary>
- Returns the ID of the producers transaction
- </summary>
- </member>
- <member name="M:Apache.NMS.Stomp.Commands.ConnectionError.GetDataStructureType">
-
- <summery>
- Get the unique identifier that this object and its own
- Marshaler share.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.Stomp.Commands.ConnectionError.ToString">
-
- <summery>
- Returns a string containing the information for this DataStructure
- such as its type and value of its elements.
- </summery>
-
- </member>
- <member name="P:Apache.NMS.Stomp.Commands.ConnectionError.IsConnectionError">
-
- <summery>
- Return an answer of true to the isConnectionError() query.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.Stomp.Commands.ConnectionId.GetDataStructureType">
-
- <summery>
- Get the unique identifier that this object and its own
- Marshaler share.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.Stomp.Commands.ConnectionId.ToString">
-
- <summery>
- Returns a string containing the information for this DataStructure
- such as its type and value of its elements.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.Stomp.Commands.ConnectionInfo.GetDataStructureType">
- <summery>
- Get the unique identifier that this object and its own
- Marshaler share.
- </summery>
- </member>
- <member name="M:Apache.NMS.Stomp.Commands.ConnectionInfo.ToString">
- <summery>
- Returns a string containing the information for this DataStructure
- such as its type and value of its elements.
- </summery>
- </member>
- <member name="P:Apache.NMS.Stomp.Commands.ConnectionInfo.IsConnectionInfo">
- <summery>
- Return an answer of true to the isConnectionInfo() query.
- </summery>
- </member>
- <member name="M:Apache.NMS.Stomp.Commands.ConsumerId.GetDataStructureType">
-
- <summery>
- Get the unique identifier that this object and its own
- Marshaler share.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.Stomp.Commands.ConsumerId.ToString">
-
- <summery>
- Returns a string containing the information for this DataStructure
- such as its type and value of its elements.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.Stomp.Commands.ConsumerInfo.GetDataStructureType">
-
- <summery>
- Get the unique identifier that this object and its own
- Marshaler share.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.Stomp.Commands.ConsumerInfo.ToString">
-
- <summery>
- Returns a string containing the information for this DataStructure
- such as its type and value of its elements.
- </summery>
-
- </member>
- <member name="P:Apache.NMS.Stomp.Commands.ConsumerInfo.IsConsumerInfo">
-
- <summery>
- Return an answer of true to the isConsumerInfo() query.
- </summery>
-
- </member>
- <member name="T:Apache.NMS.Stomp.Commands.Destination">
- <summary>
- Summary description for Destination.
- </summary>
- </member>
- <member name="F:Apache.NMS.Stomp.Commands.Destination.STOMP_TOPIC">
- <summary>
- Topic Destination object
- </summary>
- </member>
- <member name="F:Apache.NMS.Stomp.Commands.Destination.STOMP_TEMPORARY_TOPIC">
- <summary>
- Temporary Topic Destination object
- </summary>
- </member>
- <member name="F:Apache.NMS.Stomp.Commands.Destination.STOMP_QUEUE">
- <summary>
- Queue Destination object
- </summary>
- </member>
- <member name="F:Apache.NMS.Stomp.Commands.Destination.STOMP_TEMPORARY_QUEUE">
- <summary>
- Temporary Queue Destination object
- </summary>
- </member>
- <member name="M:Apache.NMS.Stomp.Commands.Destination.#ctor">
- <summary>
- The Default Constructor
- </summary>
- </member>
- <member name="M:Apache.NMS.Stomp.Commands.Destination.#ctor(System.String)">
- <summary>
- Construct the Destination with a defined physical name;
- </summary>
- <param name="name"></param>
- </member>
- <member name="M:Apache.NMS.Stomp.Commands.Destination.Transform(Apache.NMS.IDestination)">
- <summary>
- </summary>
- <param name="destination"></param>
- <returns></returns>
- </member>
- <member name="M:Apache.NMS.Stomp.Commands.Destination.CreateDestination(System.Int32,System.String,System.Boolean)">
- <summary>
- Create a Destination using the name given, the type is determined by the
- value of the type parameter.
- </summary>
- <param name="type"></param>
- <param name="pyhsicalName"></param>
- <param name="remote"></param>
- <returns></returns>
- </member>
- <member name="M:Apache.NMS.Stomp.Commands.Destination.CompareTo(System.Object)">
- <summary>
- </summary>
- <param name="o">object to compare</param>
- <returns>1 if this is less than o else 0 if they are equal or -1 if this is less than o</returns>
- </member>
- <member name="M:Apache.NMS.Stomp.Commands.Destination.CompareTo(Apache.NMS.Stomp.Commands.Destination)">
- <summary>
- Lets sort by name first then lets sort topics greater than queues
- </summary>
- <param name="that">another destination to compare against</param>
- <returns>1 if this is less than o else 0 if they are equal or -1 if this is less than o</returns>
- </member>
- <member name="M:Apache.NMS.Stomp.Commands.Destination.GetDestinationType">
- <summary>
- </summary>
- <returns>Returns the Destination type</returns>
- </member>
- <member name="M:Apache.NMS.Stomp.Commands.Destination.ToString">
- <summary>
- </summary>
- <returns>string representation of this instance</returns>
- </member>
- <member name="M:Apache.NMS.Stomp.Commands.Destination.GetHashCode">
- <summary>
- </summary>
- <returns>hashCode for this instance</returns>
- </member>
- <member name="M:Apache.NMS.Stomp.Commands.Destination.Equals(System.Object)">
- <summary>
- if the object passed in is equivalent, return true
- </summary>
- <param name="obj">the object to compare</param>
- <returns>true if this instance and obj are equivalent</returns>
- </member>
- <member name="M:Apache.NMS.Stomp.Commands.Destination.CreateDestination(System.String)">
- <summary>
- Factory method to create a child destination if this destination is a composite
- </summary>
- <param name="name"></param>
- <returns>the created Destination</returns>
- </member>
- <member name="P:Apache.NMS.Stomp.Commands.Destination.Options">
- <summary>
- Dictionary of name/value pairs representing option values specified
- in the URI used to create this Destination. A null value is returned
- if no options were specified.
- </summary>
- </member>
- <member name="P:Apache.NMS.Stomp.Commands.Destination.RemoteDestination">
- <summary>
- Indicates if the Desination was created by this client or was provided
- by the broker, most commonly the deinstinations provided by the broker
- are those that appear in the ReplyTo field of a Message.
- </summary>
- </member>
- <member name="P:Apache.NMS.Stomp.Commands.Destination.IsComposite">
- <summary>
- Returns true if this destination represents a collection of
- destinations; allowing a set of destinations to be published to or subscribed
- from in one NMS operation.
- </summary>
- </member>
- <member name="M:Apache.NMS.Stomp.Commands.Response.ToString">
-
- <summery>
- Returns a string containing the information for this DataStructure
- such as its type and value of its elements.
- </summery>
-
- </member>
- <member name="P:Apache.NMS.Stomp.Commands.Response.IsResponse">
-
- <summery>
- Return an answer of true to the isResponse() query.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.Stomp.Commands.ExceptionResponse.GetDataStructureType">
-
- <summery>
- Get the unique identifier that this object and its own
- Marshaler share.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.Stomp.Commands.ExceptionResponse.ToString">
-
- <summery>
- Returns a string containing the information for this DataStructure
- such as its type and value of its elements.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.Stomp.Commands.KeepAliveInfo.GetDataStructureType">
-
- <summery>
- Get the unique identifier that this object and its own
- Marshaler share.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.Stomp.Commands.KeepAliveInfo.ToString">
-
- <summery>
- Returns a string containing the information for this DataStructure
- such as its type and value of its elements.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.Stomp.Commands.KeepAliveInfo.visit(Apache.NMS.Stomp.State.ICommandVisitor)">
-
- <summery>
- Allows a Visitor to visit this command and return a response to the
- command based on the command type being visited. The command will call
- the proper processXXX method in the visitor.
- </summery>
-
- </member>
- <member name="P:Apache.NMS.Stomp.Commands.KeepAliveInfo.IsKeepAliveInfo">
-
- <summery>
- Return an answer of true to the isKeepAliveInfo() query.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.Stomp.Commands.MessageAck.GetDataStructureType">
-
- <summery>
- Get the unique identifier that this object and its own
- Marshaler share.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.Stomp.Commands.MessageAck.ToString">
-
- <summery>
- Returns a string containing the information for this DataStructure
- such as its type and value of its elements.
- </summery>
-
- </member>
- <member name="P:Apache.NMS.Stomp.Commands.MessageAck.IsMessageAck">
-
- <summery>
- Return an answer of true to the isMessageAck() query.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.Stomp.Commands.MessageDispatch.GetDataStructureType">
-
- <summery>
- Get the unique identifier that this object and its own
- Marshaler share.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.Stomp.Commands.MessageDispatch.ToString">
-
- <summery>
- Returns a string containing the information for this DataStructure
- such as its type and value of its elements.
- </summery>
-
- </member>
- <member name="P:Apache.NMS.Stomp.Commands.MessageDispatch.IsMessageDispatch">
-
- <summery>
- Return an answer of true to the isMessageDispatch() query.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.Stomp.Commands.MessageId.GetDataStructureType">
-
- <summery>
- Get the unique identifier that this object and its own
- Marshaler share.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.Stomp.Commands.MessageId.ToString">
-
- <summery>
- Returns a string containing the information for this DataStructure
- such as its type and value of its elements.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.Stomp.Commands.MessageId.SetValue(System.String)">
- <summary>
- Sets the value as a String
- </summary>
- </member>
- <member name="M:Apache.NMS.Stomp.Commands.ProducerId.GetDataStructureType">
-
- <summery>
- Get the unique identifier that this object and its own
- Marshaler share.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.Stomp.Commands.ProducerId.ToString">
-
- <summery>
- Returns a string containing the information for this DataStructure
- such as its type and value of its elements.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.Stomp.Commands.ProducerInfo.GetDataStructureType">
-
- <summery>
- Get the unique identifier that this object and its own
- Marshaler share.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.Stomp.Commands.ProducerInfo.ToString">
-
- <summery>
- Returns a string containing the information for this DataStructure
- such as its type and value of its elements.
- </summery>
-
- </member>
- <member name="P:Apache.NMS.Stomp.Commands.ProducerInfo.IsProducerInfo">
-
- <summery>
- Return an answer of true to the isProducerInfo() query.
- </summery>
-
- </member>
- <member name="T:Apache.NMS.Stomp.Commands.Queue">
- <summary>
- Summary description for Queue.
- </summary>
- </member>
- <member name="M:Apache.NMS.Stomp.Commands.RemoveInfo.ToString">
-
- <summery>
- Returns a string containing the information for this DataStructure
- such as its type and value of its elements.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.Stomp.Commands.RemoveInfo.visit(Apache.NMS.Stomp.State.ICommandVisitor)">
-
- <summery>
- Allows a Visitor to visit this command and return a response to the
- command based on the command type being visited. The command will call
- the proper processXXX method in the visitor.
- </summery>
-
- </member>
- <member name="P:Apache.NMS.Stomp.Commands.RemoveInfo.IsRemoveInfo">
-
- <summery>
- Return an answer of true to the isRemoveInfo() query.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.Stomp.Commands.RemoveSubscriptionInfo.GetDataStructureType">
-
- <summery>
- Get the unique identifier that this object and its own
- Marshaler share.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.Stomp.Commands.RemoveSubscriptionInfo.ToString">
-
- <summery>
- Returns a string containing the information for this DataStructure
- such as its type and value of its elements.
- </summery>
-
- </member>
- <member name="P:Apache.NMS.Stomp.Commands.RemoveSubscriptionInfo.IsRemoveSubscriptionInfo">
-
- <summery>
- Return an answer of true to the isRemoveSubscriptionInfo() query.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.Stomp.Commands.SessionId.GetDataStructureType">
-
- <summery>
- Get the unique identifier that this object and its own
- Marshaler share.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.Stomp.Commands.SessionId.ToString">
-
- <summery>
- Returns a string containing the information for this DataStructure
- such as its type and value of its elements.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.Stomp.Commands.SessionInfo.GetDataStructureType">
-
- <summery>
- Get the unique identifier that this object and its own
- Marshaler share.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.Stomp.Commands.SessionInfo.ToString">
-
- <summery>
- Returns a string containing the information for this DataStructure
- such as its type and value of its elements.
- </summery>
-
- </member>
- <member name="P:Apache.NMS.Stomp.Commands.SessionInfo.IsSessionInfo">
-
- <summery>
- Return an answer of true to the isSessionInfo() query.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.Stomp.Commands.ShutdownInfo.GetDataStructureType">
-
- <summery>
- Get the unique identifier that this object and its own
- Marshaler share.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.Stomp.Commands.ShutdownInfo.ToString">
-
- <summery>
- Returns a string containing the information for this DataStructure
- such as its type and value of its elements.
- </summery>
-
- </member>
- <member name="P:Apache.NMS.Stomp.Commands.ShutdownInfo.IsShutdownInfo">
-
- <summery>
- Return an answer of true to the isShutdownInfo() query.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.Stomp.Commands.SubscriptionInfo.GetDataStructureType">
-
- <summery>
- Get the unique identifier that this object and its own
- Marshaler share.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.Stomp.Commands.SubscriptionInfo.ToString">
-
- <summery>
- Returns a string containing the information for this DataStructure
- such as its type and value of its elements.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.Stomp.Commands.TempDestination.GetDestinationType">
- <summary>
- Method GetDestinationType
- </summary>
- <returns>An int</returns>
- </member>
- <member name="M:Apache.NMS.Stomp.Commands.TempDestination.CreateDestination(System.String)">
- <summary>
- Method CreateDestination
- </summary>
- <returns>An Destination</returns>
- <param name="name">A String</param>
- </member>
- <member name="T:Apache.NMS.Stomp.Commands.TempQueue">
- <summary>
- A Temporary Queue
- </summary>
- </member>
- <member name="T:Apache.NMS.Stomp.Commands.TempTopic">
- <summary>
- A Temporary Topic
- </summary>
- </member>
- <member name="T:Apache.NMS.Stomp.Commands.Topic">
- <summary>
- Summary description for Topic.
- </summary>
- </member>
- <member name="M:Apache.NMS.Stomp.Commands.TransactionId.GetDataStructureType">
-
- <summery>
- Get the unique identifier that this object and its own
- Marshaler share.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.Stomp.Commands.TransactionId.ToString">
-
- <summery>
- Returns a string containing the information for this DataStructure
- such as its type and value of its elements.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.Stomp.Commands.TransactionInfo.GetDataStructureType">
-
- <summery>
- Get the unique identifier that this object and its own
- Marshaler share.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.Stomp.Commands.TransactionInfo.ToString">
-
- <summery>
- Returns a string containing the information for this DataStructure
- such as its type and value of its elements.
- </summery>
-
- </member>
- <member name="P:Apache.NMS.Stomp.Commands.TransactionInfo.IsTransactionInfo">
-
- <summery>
- Return an answer of true to the isTransactionInfo() query.
- </summery>
-
- </member>
- <member name="M:Apache.NMS.Stomp.Commands.WireFormatInfo.GetDataStructureType">
- <summery>
- Get the unique identifier that this object and its own
- Marshaler share.
- </summery>
- </member>
- <member name="M:Apache.NMS.Stomp.Commands.WireFormatInfo.ToString">
- <summery>
- Returns a string containing the information for this DataStructure
- such as its type and value of its elements.
- </summery>
- </member>
- <member name="P:Apache.NMS.Stomp.Commands.WireFormatInfo.IsWireFormatInfo">
- <summery>
- Return an answer of true to the IsWireFormatInfo() query.
- </summery>
- </member>
- <member name="T:Apache.NMS.Stomp.Protocol.IPrimitiveMapMarshaler">
- <summary>
- Interface for a utility class used to marshal an IPrimitiveMap instance
- to/from an String.
- </summary>
- </member>
- <member name="M:Apache.NMS.Stomp.Protocol.IPrimitiveMapMarshaler.Marshal(Apache.NMS.IPrimitiveMap)">
- <summary>
- Marshals a PrimitiveMap instance to an serialized byte array.
- </summary>
- </member>
- <member name="M:Apache.NMS.Stomp.Protocol.IPrimitiveMapMarshaler.Unmarshal(System.Byte[])">
- <summary>
- Un-marshals an IPrimitiveMap instance from a String object.
- </summary>
- </member>
- <member name="P:Apache.NMS.Stomp.Protocol.IPrimitiveMapMarshaler.Name">
- <summary>
- Retreives the Name of this Marshaler.
- </summary>
- </member>
- <member name="F:Apache.NMS.Stomp.Protocol.StompFrame.NEWLINE">
- Used to terminate a header line or end of a headers section of the Frame.
- </member>
- <member name="F:Apache.NMS.Stomp.Protocol.StompFrame.SEPARATOR">
- Used to seperate the Key / Value pairing in Frame Headers
- </member>
- <member name="F:Apache.NMS.Stomp.Protocol.StompFrame.FRAME_TERMINUS">
- Used to mark the End of the Frame.
- </member>
- <member name="F:Apache.NMS.Stomp.Protocol.StompFrame.KEEPALIVE">
- Used to denote a Special KeepAlive command that consists of a single newline.
- </member>
- <member name="T:Apache.NMS.Stomp.Protocol.StompHelper">
- <summary>
- Some <a href="http://stomp.codehaus.org/">STOMP</a> protocol conversion helper methods.
- </summary>
- </member>
- <member name="T:Apache.NMS.Stomp.Protocol.StompWireFormat">
- <summary>
- Implements the <a href="http://stomp.codehaus.org/">STOMP</a> protocol.
- </summary>
- </member>
- <member name="T:Apache.NMS.Stomp.Transport.IWireFormat">
- <summary>
- Represents the marshalling of commands to and from an IO stream
- </summary>
- </member>
- <member name="M:Apache.NMS.Stomp.Transport.IWireFormat.Marshal(System.Object,System.IO.BinaryWriter)">
- <summary>
- Marshalls the given command object onto the stream
- </summary>
- </member>
- <member name="M:Apache.NMS.Stomp.Transport.IWireFormat.Unmarshal(System.IO.BinaryReader)">
- <summary>
- Unmarshalls the next command object from the stream
- </summary>
- </member>
- <member name="T:Apache.NMS.Stomp.Protocol.XmlPrimitiveMapMarshaler">
- <summary>
- Reads / Writes an IPrimitveMap as XML compatible with XStream.
- </summary>
- </member>
- <member name="T:Apache.NMS.Stomp.State.ConnectionStateTracker">
- <summary>
- Tracks the state of a connection so a newly established transport can be
- re-initialized to the state that was tracked.
- </summary>
- </member>
- <member name="M:Apache.NMS.Stomp.State.ConnectionStateTracker.track(Apache.NMS.Stomp.Commands.Command)">
- <summary>
- </summary>
- <param name="command"></param>
- <returns>null if the command is not state tracked.</returns>
- </member>
- <member name="M:Apache.NMS.Stomp.State.ConnectionStateTracker.DoRestoreConsumers(Apache.NMS.Stomp.Transport.ITransport,Apache.NMS.Stomp.State.ConnectionState)">
- <summary>
- </summary>
- <param name="transport"></param>
- <param name="connectionState"></param>
- </member>
- <member name="T:Apache.NMS.Stomp.Threads.CompositeTask">
- <summary>
- A Composite task is one of N tasks that can be managed by a
- CompositTaskRunner instance. The CompositeTaskRunner checks each
- task when its wakeup method is called to determine if the Task has
- any work it needs to complete, if no tasks have any pending work
- then the CompositeTaskRunner can return to its sleep state until
- the next time its wakeup method is called or it is shut down.
- </summary>
- </member>
- <member name="T:Apache.NMS.Stomp.Threads.Task">
- <summary>
- Represents a task that may take a few iterations to complete.
- </summary>
- </member>
- <member name="P:Apache.NMS.Stomp.Threads.CompositeTask.IsPending">
- <summary>
- Indicates if this Task has any pending work.
- </summary>
- </member>
- <member name="T:Apache.NMS.Stomp.Threads.CompositeTaskRunner">
- <summary>
- A TaskRunner that dedicates a single thread to running a single Task.
- </summary>
- </member>
- <member name="T:Apache.NMS.Stomp.Threads.TaskRunner">
- <summary>
- Allows you to request a thread execute the associated Task.
- </summary>
- </member>
- <member name="T:Apache.NMS.Stomp.Threads.DedicatedTaskRunner">
- <summary>
- A TaskRunner that dedicates a single thread to running a single Task.
- </summary>
- </member>
- <member name="T:Apache.NMS.Stomp.Threads.ThreadPoolExecutor">
- <summary>
- This class provides a wrapper around the ThreadPool mechanism in .NET
- to allow for serial execution of jobs in the ThreadPool and provide
- a means of shutting down the execution of jobs in a deterministic
- way.
- </summary>
- </member>
- <member name="T:Apache.NMS.Stomp.Threads.ThreadPoolExecutor.Future">
- <summary>
- Represents an asynchronous task that is executed on the ThreadPool
- at some point in the future.
- </summary>
- </member>
- <member name="T:Apache.NMS.Stomp.Transport.Failover.FailoverTransport">
- <summary>
- A Transport that is made reliable by being able to fail over to another
- transport when a transport failure is detected.
- </summary>
- </member>
- <member name="T:Apache.NMS.Stomp.Transport.ITransport">
- <summary>
- Represents the logical networking transport layer. Transports implment the low
- level protocol specific portion of the Communication between the Client and a Broker
- such as TCP, UDP, etc. Transports make use of WireFormat objects to handle translateing
- the cononical OpenWire Commands used in this client into binary wire level packets that
- can be sent to the Broker or Service that the Transport connects to.
- </summary>
- </member>
- <member name="M:Apache.NMS.Stomp.Transport.ITransport.Oneway(Apache.NMS.Stomp.Commands.Command)">
- <summary>
- Sends a Command object on the Wire but does not wait for any response from the
- receiver before returning.
- </summary>
- <param name="command">
- A <see cref="P:Apache.NMS.Stomp.Transport.ITransport.Command"/>
- </param>
- </member>
- <member name="M:Apache.NMS.Stomp.Transport.ITransport.AsyncRequest(Apache.NMS.Stomp.Commands.Command)">
- <summary>
- Sends a Command object which requires a response from the Broker but does not
- wait for the response, instead a FutureResponse object is returned that the
- caller can use to wait on the Broker's response.
- </summary>
- </member>
- <member name="M:Apache.NMS.Stomp.Transport.ITransport.Request(Apache.NMS.Stomp.Commands.Command)">
- <summary>
- Sends a Command to the Broker and waits for a Response to that Command before
- returning, this version waits indefinitely for a response.
- </summary>
- </member>
- <member name="M:Apache.NMS.Stomp.Transport.ITransport.Request(Apache.NMS.Stomp.Commands.Command,System.TimeSpan)">
- <summary>
- Sends a Command to the Broker and waits for the given TimeSpan to expire for a
- response before returning.
- </summary>
- </member>
- <member name="M:Apache.NMS.Stomp.Transport.ITransport.Narrow(System.Type)">
- <summary>
- Allows a caller to find a specific type of Transport in the Chain of
- Transports that is created. This allows a caller to find a specific
- object in the Transport chain and set or get properties on that specific
- instance. If the requested type isn't in the chain than Null is returned.
- </summary>
- </member>
- <member name="P:Apache.NMS.Stomp.Transport.ITransport.Timeout">
- <summary>
- Timeout in milliseconds to wait for sending synchronous messages or commands.
- Set to -1 for infinite timeout.
- </summary>
- </member>
- <member name="P:Apache.NMS.Stomp.Transport.ITransport.AsyncTimeout">
- <summary>
- Timeout in milliseconds to wait for sending asynchronous messages or commands.
- Set to -1 for infinite timeout.
- </summary>
- </member>
- <member name="P:Apache.NMS.Stomp.Transport.ITransport.IsDisposed">
- <value>
- Indicates if this Transport has already been disposed and can no longer
- be used.
- </value>
- </member>
- <member name="P:Apache.NMS.Stomp.Transport.ITransport.IsFaultTolerant">
- <value>
- Indicates if this Transport is Fault Tolerant or not. A fault Tolerant
- Transport handles low level connection errors internally allowing a client
- to remain unaware of wire level disconnection and reconnection details.
- </value>
- </member>
- <member name="P:Apache.NMS.Stomp.Transport.ITransport.IsConnected">
- <value>
- Indiciates if the Transport is current Connected to is assigned URI.
- </value>
- </member>
- <member name="P:Apache.NMS.Stomp.Transport.ITransport.RemoteAddress">
- <value>
- The Remote Address that this transport is currently connected to.
- </value>
- </member>
- <member name="M:Apache.NMS.Stomp.Transport.Failover.FailoverTransport.IsShutdownCommand(Apache.NMS.Stomp.Commands.Command)">
- <summary>
- </summary>
- <param name="command"></param>
- <returns>Returns true if the command is one sent when a connection is being closed.</returns>
- </member>
- <member name="P:Apache.NMS.Stomp.Transport.Failover.FailoverTransport.AsyncTimeout">
- <summary>
- If doing an asynchronous connect, the milliseconds before timing out if no connection can be made
- </summary>
- <value>The async timeout.</value>
- </member>
- <member name="M:Apache.NMS.Stomp.Transport.Failover.FailoverTransportFactory.CreateTransport(Apache.NMS.Util.URISupport.CompositeData)">
- <summary>
- </summary>
- <param name="compositData"></param>
- <returns></returns>
- </member>
- <member name="T:Apache.NMS.Stomp.Transport.Tcp.TcpTransport">
- <summary>
- An implementation of ITransport that uses sockets to communicate with the broker
- </summary>
- </member>
- <member name="M:Apache.NMS.Stomp.Transport.Tcp.TcpTransport.Start">
- <summary>
- Method Start
- </summary>
- </member>
- <member name="P:Apache.NMS.Stomp.Transport.Tcp.TcpTransport.IsStarted">
- <summary>
- Property IsStarted
- </summary>
- </member>
- <member name="P:Apache.NMS.Stomp.Transport.Tcp.TcpTransport.Timeout">
- <summary>
- Timeout in milliseconds to wait for sending synchronous messages or commands.
- Set to -1 for infinite timeout.
- </summary>
- </member>
- <member name="P:Apache.NMS.Stomp.Transport.Tcp.TcpTransport.AsyncTimeout">
- <summary>
- Timeout in milliseconds to wait for sending asynchronous messages or commands.
- Set to -1 for infinite timeout.
- </summary>
- </member>
- <member name="P:Apache.NMS.Stomp.Transport.Tcp.SslTransport.ServerName">
- <summary>
- Indicates the name of the Server's Certificate. By default the Host name
- of the remote server is used, however if this doesn't match the name of the
- Server's certificate then this option can be set to override the default.
- </summary>
- </member>
- <member name="P:Apache.NMS.Stomp.Transport.Tcp.SslTransport.ClientCertFilename">
- <summary>
- Indicates the location of the Client Certificate to use when the Broker
- is configured for Client Auth (not common). The SslTransport will supply
- this certificate to the SslStream via the SelectLocalCertificate method.
- </summary>
- </member>
- <member name="P:Apache.NMS.Stomp.Transport.Tcp.SslTransport.ClientCertPassword">
- <summary>
- Password for the Client Certificate specified via configuration.
- </summary>
- </member>
- <member name="P:Apache.NMS.Stomp.Transport.Tcp.SslTransport.AcceptInvalidBrokerCert">
- <summary>
- Indicates if the SslTransport should ignore any errors in the supplied Broker
- certificate and connect anyway, this is useful in testing with a default AMQ
- broker certificate that is self signed.
- </summary>
- </member>
- <member name="F:Apache.NMS.Stomp.Transport.Tcp.TcpTransportFactory.useInactivityMonitor">
- <summary>
- Should the Inactivity Monitor be enabled on this Transport.
- </summary>
- </member>
- <member name="F:Apache.NMS.Stomp.Transport.Tcp.TcpTransportFactory.receiveBufferSize">
- <summary>
- Size in bytes of the receive buffer.
- </summary>
- </member>
- <member name="F:Apache.NMS.Stomp.Transport.Tcp.TcpTransportFactory.sendBufferSize">
- <summary>
- Size in bytes of send buffer.
- </summary>
- </member>
- <member name="F:Apache.NMS.Stomp.Transport.Tcp.TcpTransportFactory.receiveTimeout">
- <summary>
- The time-out value, in milliseconds. The default value is 0, which indicates
- an infinite time-out period. Specifying -1 also indicates an infinite time-out period.
- </summary>
- </member>
- <member name="F:Apache.NMS.Stomp.Transport.Tcp.TcpTransportFactory.sendTimeout">
- <summary>
- The time-out value, in milliseconds. If you set the property with a value between 1 and 499,
- the value will be changed to 500. The default value is 0, which indicates an infinite
- time-out period. Specifying -1 also indicates an infinite time-out period.
- </summary>
- </member>
- <member name="M:Apache.NMS.Stomp.Transport.Tcp.TcpTransportFactory.DoCreateTransport(System.Uri,System.Net.Sockets.Socket,Apache.NMS.Stomp.Transport.IWireFormat)">
- <summary>
- Override in a subclass to create the specific type of transport that is
- being implemented.
- </summary>
- </member>
- <member name="T:Apache.NMS.Stomp.Transport.FutureResponse">
- <summary>
- Handles asynchronous responses
- </summary>
- </member>
- <member name="T:Apache.NMS.Stomp.Transport.InactivityMonitor">
- <summary>
- This class make sure that the connection is still alive,
- by monitoring the reception of commands from the peer of
- the transport.
- </summary>
- </member>
- <member name="T:Apache.NMS.Stomp.Transport.TransportFilter">
- <summary>
- Used to implement a filter on the transport layer.
- </summary>
- </member>
- <member name="M:Apache.NMS.Stomp.Transport.TransportFilter.Oneway(Apache.NMS.Stomp.Commands.Command)">
- <summary>
- Method Oneway
- </summary>
- <param name="command">A Command</param>
- </member>
- <member name="M:Apache.NMS.Stomp.Transport.TransportFilter.AsyncRequest(Apache.NMS.Stomp.Commands.Command)">
- <summary>
- Method AsyncRequest
- </summary>
- <returns>A FutureResponse</returns>
- <param name="command">A Command</param>
- </member>
- <member name="M:Apache.NMS.Stomp.Transport.TransportFilter.Request(Apache.NMS.Stomp.Commands.Command)">
- <summary>
- Method Request
- </summary>
- <returns>A Response</returns>
- <param name="command">A Command</param>
- </member>
- <member name="M:Apache.NMS.Stomp.Transport.TransportFilter.Request(Apache.NMS.Stomp.Commands.Command,System.TimeSpan)">
- <summary>
- Method Request with time out for Response.
- </summary>
- <returns>A Response</returns>
- <param name="command">A Command</param>
- <param name="timeout">Timeout in milliseconds</param>
- </member>
- <member name="M:Apache.NMS.Stomp.Transport.TransportFilter.Start">
- <summary>
- Method Start
- </summary>
- </member>
- <member name="M:Apache.NMS.Stomp.Transport.TransportFilter.Dispose">
- <summary>
- Method Dispose
- </summary>
- </member>
- <member name="P:Apache.NMS.Stomp.Transport.TransportFilter.IsStarted">
- <summary>
- Property IsStarted
- </summary>
- </member>
- <member name="P:Apache.NMS.Stomp.Transport.TransportFilter.Timeout">
- <summary>
- Timeout in milliseconds to wait for sending synchronous messages or commands.
- Set to -1 for infinite timeout.
- </summary>
- </member>
- <member name="P:Apache.NMS.Stomp.Transport.TransportFilter.AsyncTimeout">
- <summary>
- Timeout in milliseconds to wait for sending asynchronous messages or commands.
- Set to -1 for infinite timeout.
- </summary>
- </member>
- <member name="M:Apache.NMS.Stomp.Transport.InactivityMonitor.#ctor(Apache.NMS.Stomp.Transport.ITransport)">
- <summary>
- Constructor or the Inactivity Monitor
- </summary>
- <param name="next"></param>
- </member>
- <member name="M:Apache.NMS.Stomp.Transport.InactivityMonitor.WriteCheck">
- <summary>
- Check the write to the broker
- </summary>
- </member>
- <member name="M:Apache.NMS.Stomp.Transport.InactivityMonitor.AllowReadCheck(System.TimeSpan)">
- <summary>
- Checks if we should allow the read check(if less than 90% of the read
- check time elapsed then we dont do the readcheck
- </summary>
- <param name="elapsed"></param>
- <returns></returns>
- </member>
- <member name="T:Apache.NMS.Stomp.Transport.LoggingTransport">
- <summary>
- A Transport filter that is used to log the commands sent and received.
- </summary>
- </member>
- <member name="T:Apache.NMS.Stomp.Transport.MutexTransport">
- <summary>
- A Transport which guards access to the next transport using a mutex.
- </summary>
- </member>
- <member name="T:Apache.NMS.Stomp.Transport.ResponseCorrelator">
- <summary>
- A Transport that correlates asynchronous send/receive messages into single request/response.
- </summary>
- </member>
- <member name="M:Apache.NMS.Stomp.Transport.TransportFactory.CreateTransport(System.Uri)">
- <summary>
- Creates a normal transport.
- </summary>
- <param name="location"></param>
- <returns>the transport</returns>
- </member>
- <member name="M:Apache.NMS.Stomp.Transport.TransportFactory.CreateTransportFactory(System.Uri)">
- <summary>
- Create a transport factory for the scheme. If we do not support the transport protocol,
- an NMSConnectionException will be thrown.
- </summary>
- <param name="location"></param>
- <returns></returns>
- </member>
- <member name="M:Apache.NMS.Stomp.Util.IdGenerator.#ctor(System.String)">
- Construct an IdGenerator
- </member>
- <member name="M:Apache.NMS.Stomp.Util.IdGenerator.GenerateId">
- <summary>
- Generate a Unique Id
- </summary>
- </member>
- <member name="M:Apache.NMS.Stomp.Util.IdGenerator.GenerateSanitizedId">
- <summary>
- Generate a unique ID - that is friendly for a URL or file system
- </summary>
- </member>
- <member name="M:Apache.NMS.Stomp.Util.IdGenerator.GetSeedFromId(System.String)">
- <summary>
- From a generated id - return the seed (i.e. minus the count)
- </summary>
- </member>
- <member name="M:Apache.NMS.Stomp.Util.IdGenerator.GetSequenceFromId(System.String)">
- <summary>
- From a generated id - return the generator count
- </summary>
- </member>
- <member name="M:Apache.NMS.Stomp.Util.IdGenerator.Compare(System.String,System.String)">
- <summary>
- Does a proper compare on the ids
- </summary>
- </member>
- <member name="P:Apache.NMS.Stomp.Util.IdGenerator.HostName">
- <summary>
- As we have to find the hostname as a side-affect of generating a unique
- stub, we allow it's easy retrevial here
- </summary>
- </member>
- <member name="T:Apache.NMS.Stomp.BrokerException">
- <summary>
- Exception thrown when the broker returns an error
- </summary>
- </member>
- <member name="M:Apache.NMS.Stomp.BrokerException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Initializes a new instance of the BrokerException class with serialized data.
- Throws System.ArgumentNullException if the info parameter is null.
- Throws System.Runtime.Serialization.SerializationException if the class name is null or System.Exception.HResult is zero (0).
- </summary>
- <param name="info">The SerializationInfo that holds the serialized object data about the exception being thrown.</param>
- <param name="context">The StreamingContext that contains contextual information about the source or destination.</param>
- </member>
- <member name="M:Apache.NMS.Stomp.BrokerException.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- When overridden in a derived class, sets the SerializationInfo
- with information about the exception.
- </summary>
- <param name="info">The SerializationInfo that holds the serialized object data about the exception being thrown.</param>
- <param name="context">The StreamingContext that contains contextual information about the source or destination.</param>
- </member>
- <member name="M:Apache.NMS.Stomp.BrokerException.StackTraceDump(Apache.NMS.Stomp.Commands.StackTraceElement[])">
- <summary>
- Generates a nice textual stack trace
- </summary>
- </member>
- <member name="T:Apache.NMS.Stomp.Connection">
- <summary>
- Represents a connection with a message broker
- </summary>
- </member>
- <member name="M:Apache.NMS.Stomp.Connection.Start">
- <summary>
- Starts asynchronous message delivery of incoming messages for this connection.
- Synchronous delivery is unaffected.
- </summary>
- </member>
- <member name="M:Apache.NMS.Stomp.Connection.Stop">
- <summary>
- Temporarily stop asynchronous delivery of inbound messages for this connection.
- The sending of outbound messages is unaffected.
- </summary>
- </member>
- <member name="M:Apache.NMS.Stomp.Connection.CreateSession">
- <summary>
- Creates a new session to work on this connection
- </summary>
- </member>
- <member name="M:Apache.NMS.Stomp.Connection.CreateSession(Apache.NMS.AcknowledgementMode)">
- <summary>
- Creates a new session to work on this connection
- </summary>
- </member>
- <member name="M:Apache.NMS.Stomp.Connection.SyncRequest(Apache.NMS.Stomp.Commands.Command)">
- <summary>
- Performs a synchronous request-response with the broker
- </summary>
-
- </member>
- <member name="M:Apache.NMS.Stomp.Connection.CheckConnected">
- <summary>
- Check and ensure that the connection objcet is connected. If it is not
- connected or is closed, a ConnectionClosedException is thrown.
- </summary>
- </member>
- <member name="M:Apache.NMS.Stomp.Connection.OnCommand(Apache.NMS.Stomp.Transport.ITransport,Apache.NMS.Stomp.Commands.Command)">
- <summary>
- Handle incoming commands
- </summary>
- <param name="commandTransport">An ITransport</param>
- <param name="command">A Command</param>
- </member>
- <member name="M:Apache.NMS.Stomp.Connection.CreateTemporaryDestinationName">
- <summary>
- Creates a new temporary destination name
- </summary>
- </member>
- <member name="M:Apache.NMS.Stomp.Connection.CreateLocalTransactionId">
- <summary>
- Creates a new local transaction ID
- </summary>
- </member>
- <member name="E:Apache.NMS.Stomp.Connection.ExceptionListener">
- <summary>
- A delegate that can receive transport level exceptions.
- </summary>
- </member>
- <member name="E:Apache.NMS.Stomp.Connection.ConnectionInterruptedListener">
- <summary>
- An asynchronous listener that is notified when a Fault tolerant connection
- has been interrupted.
- </summary>
- </member>
- <member name="E:Apache.NMS.Stomp.Connection.ConnectionResumedListener">
- <summary>
- An asynchronous listener that is notified when a Fault tolerant connection
- has been resumed.
- </summary>
- </member>
- <member name="P:Apache.NMS.Stomp.Connection.AsyncSend">
- <summary>
- This property indicates whether or not async send is enabled.
- </summary>
- </member>
- <member name="P:Apache.NMS.Stomp.Connection.AckMode">
- <summary>
- This property sets the acknowledgment mode for the connection.
- The URI parameter connection.ackmode can be set to a string value
- that maps to the enumeration value.
- </summary>
- </member>
- <member name="P:Apache.NMS.Stomp.Connection.AlwaysSyncSend">
- <summary>
- This property forces all messages that are sent to be sent synchronously overriding
- any usage of the AsyncSend flag. This can reduce performance in some cases since the
- only messages we normally send synchronously are Persistent messages not sent in a
- transaction. This options guarantees that no send will return until the broker has
- acknowledge receipt of the message
- </summary>
- </member>
- <member name="P:Apache.NMS.Stomp.Connection.CopyMessageOnSend">
- <summary>
- This property indicates whether Message's should be copied before being sent via
- one of the Connection's send methods. Copying the Message object allows the user
- to resuse the Object over for another send. If the message isn't copied performance
- can improve but the user must not reuse the Object as it may not have been sent
- before they reset its payload.
- </summary>
- </member>
- <member name="P:Apache.NMS.Stomp.Connection.SendAcksAsync">
- <summary>
- This property indicates whether or not async sends are used for
- message acknowledgement messages. Sending Acks async can improve
- performance but may decrease reliability.
- </summary>
- </member>
- <member name="P:Apache.NMS.Stomp.Connection.DispatchAsync">
- <summary>
- synchronously or asynchronously by the broker. Set to false for a slow
- consumer and true for a fast consumer.
- </summary>
- </member>
- <member name="P:Apache.NMS.Stomp.Connection.Transformation">
- <summary>
- Sets the default Transformation attribute applied to Consumers. If a consumer
- is to receive Map messages from the Broker then the user should set the "jms-map-xml"
- transformation on the consumer so that all MapMessages are sent as XML.
- </summary>
- </member>
- <member name="P:Apache.NMS.Stomp.Connection.DefaultClientId">
- <summary>
- The Default Client Id used if the ClientId property is not set explicity.
- </summary>
- </member>
- <member name="P:Apache.NMS.Stomp.Connection.RedeliveryPolicy">
- <summary>
- Get/or set the redelivery policy for this connection.
- </summary>
- </member>
- <member name="P:Apache.NMS.Stomp.Connection.IsStarted">
- <summary>
- This property determines if the asynchronous message delivery of incoming
- messages has been started for this connection.
- </summary>
- </member>
- <member name="T:Apache.NMS.Stomp.ConnectionClosedException">
- <summary>
- Exception thrown when a connection is used that it already closed
- </summary>
- </member>
- <member name="M:Apache.NMS.Stomp.ConnectionClosedException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Initializes a new instance of the ConnectionClosedException class with serialized data.
- Throws System.ArgumentNullException if the info parameter is null.
- Throws System.Runtime.Serialization.SerializationException if the class name is null or System.Exception.HResult is zero (0).
- </summary>
- <param name="info">The SerializationInfo that holds the serialized object data about the exception being thrown.</param>
- <param name="context">The StreamingContext that contains contextual information about the source or destination.</param>
- </member>
- <member name="T:Apache.NMS.Stomp.ConnectionFactory">
- <summary>
- Represents a connection with a message broker
- </summary>
- </member>
- <member name="P:Apache.NMS.Stomp.ConnectionFactory.BrokerUri">
- <summary>
- Get/or set the broker Uri.
- </summary>
- </member>
- <member name="T:Apache.NMS.Stomp.ConnectionMetaData">
- <summary>
- Implements the Connection Meta-Data feature for Apache.NMS.ActiveMQ
- </summary>
- </member>
- <member name="T:Apache.NMS.Stomp.IDispatcher">
- <summary>
- Interface that provides for a Class to provide dispatching service for
- an OpenWire MessageDispatch command.
- </summary>
- </member>
- <member name="T:Apache.NMS.Stomp.IOException">
- <summary>
- Exception thrown when an IO error occurs
- </summary>
- </member>
- <member name="M:Apache.NMS.Stomp.ISynchronization.BeforeEnd">
- <summary>
- Called before a commit or rollback is applied.
- </summary>
- </member>
- <member name="M:Apache.NMS.Stomp.ISynchronization.AfterCommit">
- <summary>
- Called after a commit
- </summary>
- </member>
- <member name="M:Apache.NMS.Stomp.ISynchronization.AfterRollback">
- <summary>
- Called after a transaction rollback
- </summary>
- </member>
- <member name="T:Apache.NMS.Stomp.MessageConsumer">
- <summary>
- An object capable of receiving messages from some destination
- </summary>
- </member>
- <member name="M:Apache.NMS.Stomp.MessageConsumer.Dequeue(System.TimeSpan)">
- <summary>
- Used to get an enqueued message from the unconsumedMessages list. The
- amount of time this method blocks is based on the timeout value. if
- timeout == Timeout.Infinite then it blocks until a message is received.
- if timeout == 0 then it it tries to not block at all, it returns a
- message if it is available if timeout > 0 then it blocks up to timeout
- amount of time. Expired messages will consumed by this method.
- </summary>
- </member>
- <member name="T:Apache.NMS.Stomp.MessageProducer">
- <summary>
- An object capable of sending messages to some destination
- </summary>
- </member>
- <member name="T:Apache.NMS.Stomp.PrefetchPolicy">
- <summary>
- Class used to define the various limits that should be used for the Prefetch
- limit on destination based on the type of Destination in use.
- </summary>
- </member>
- <member name="T:Apache.NMS.Stomp.RequestTimedOutException">
- <summary>
- Exception thrown when an Request times out.
- </summary>
- </member>
- <member name="T:Apache.NMS.Stomp.Session">
- <summary>
- Default provider of ISession
- </summary>
- </member>
- <member name="F:Apache.NMS.Stomp.Session.myLock">
- <summary>
- Private object used for synchronization, instead of public "this"
- </summary>
- </member>
- <member name="M:Apache.NMS.Stomp.Session.DeleteDestination(Apache.NMS.IDestination)">
- <summary>
- Delete a destination (Queue, Topic, Temp Queue, Temp Topic).
- </summary>
- </member>
- <member name="M:Apache.NMS.Stomp.Session.DoStartTransaction">
- <summary>
- Ensures that a transaction is started
- </summary>
- </member>
- <member name="M:Apache.NMS.Stomp.Session.DoNothingAcknowledge(Apache.NMS.Stomp.Commands.Message)">
- <summary>
- Prevents message from throwing an exception if a client calls Acknoweldge on
- a message that is part of a transaction either being produced or consumed. The
- JMS Spec indicates that users should be able to call Acknowledge with no effect
- if the message is in a transaction.
- </summary>
- <param name="message">
- A <see cref="T:Apache.NMS.Stomp.Commands.Message"/>
- </param>
- </member>
- <member name="P:Apache.NMS.Stomp.Session.PrefetchSize">
- <summary>
- Sets the prefetch size, the maximum number of messages a broker will dispatch to consumers
- until acknowledgements are received.
- </summary>
- </member>
- <member name="P:Apache.NMS.Stomp.Session.MaximumPendingMessageLimit">
- <summary>
- Sets the maximum number of messages to keep around per consumer
- in addition to the prefetch window for non-durable topics until messages
- will start to be evicted for slow consumers.
- Must be > 0 to enable this feature
- </summary>
- </member>
- <member name="P:Apache.NMS.Stomp.Session.DispatchAsync">
- <summary>
- Enables or disables whether asynchronous dispatch should be used by the broker
- </summary>
- </member>
- <member name="P:Apache.NMS.Stomp.Session.Exclusive">
- <summary>
- Enables or disables exclusive consumers when using queues. An exclusive consumer means
- only one instance of a consumer is allowed to process messages on a queue to preserve order
- </summary>
- </member>
- <member name="P:Apache.NMS.Stomp.Session.Retroactive">
- <summary>
- Enables or disables retroactive mode for consumers; i.e. do they go back in time or not?
- </summary>
- </member>
- <member name="P:Apache.NMS.Stomp.Session.Priority">
- <summary>
- Sets the default consumer priority for consumers
- </summary>
- </member>
- <member name="M:Apache.NMS.Stomp.TransactionContext.AddSynchronization(Apache.NMS.Stomp.ISynchronization)">
- <summary>
- Method AddSynchronization
- </summary>
- </member>
- </members>
-</doc>
diff --git a/SallyConnect/bin/Debug/Apache.NMS.dll b/SallyConnect/bin/Debug/Apache.NMS.dll
deleted file mode 100644
index 97c6db7a40e46482c2ebe394ade8211d3786a450..0000000000000000000000000000000000000000
Binary files a/SallyConnect/bin/Debug/Apache.NMS.dll and /dev/null differ
diff --git a/SallyConnect/bin/Debug/Apache.NMS.pdb b/SallyConnect/bin/Debug/Apache.NMS.pdb
deleted file mode 100644
index 76f4506784a44509004a5b39e8f13835492474b7..0000000000000000000000000000000000000000
Binary files a/SallyConnect/bin/Debug/Apache.NMS.pdb and /dev/null differ
diff --git a/SallyConnect/bin/Debug/SallyConnect.exe b/SallyConnect/bin/Debug/SallyConnect.exe
deleted file mode 100644
index fa46768bc792f0dae1fd978f7ee84c800a6c4069..0000000000000000000000000000000000000000
Binary files a/SallyConnect/bin/Debug/SallyConnect.exe and /dev/null differ
diff --git a/SallyConnect/bin/Debug/SallyConnect.pdb b/SallyConnect/bin/Debug/SallyConnect.pdb
deleted file mode 100644
index 0a22bc0f00b476759c46663a7b2fab715e558fc6..0000000000000000000000000000000000000000
Binary files a/SallyConnect/bin/Debug/SallyConnect.pdb and /dev/null differ
diff --git a/SallyConnect/bin/Debug/SallyConnect.vshost.exe b/SallyConnect/bin/Debug/SallyConnect.vshost.exe
deleted file mode 100644
index 8c84517408d9260be5ab0fbf716b7b046c88c613..0000000000000000000000000000000000000000
Binary files a/SallyConnect/bin/Debug/SallyConnect.vshost.exe and /dev/null differ
diff --git a/SallyConnect/bin/Debug/commcore.dll b/SallyConnect/bin/Debug/commcore.dll
deleted file mode 100644
index 3e757600703709ac7a09aeb25cb5a7512dd62cb0..0000000000000000000000000000000000000000
Binary files a/SallyConnect/bin/Debug/commcore.dll and /dev/null differ
diff --git a/SallyConnect/bin/Debug/commlmh.dll b/SallyConnect/bin/Debug/commlmh.dll
deleted file mode 100644
index ee96ebea8b5e3bc02a732635ceec64630cf3892d..0000000000000000000000000000000000000000
Binary files a/SallyConnect/bin/Debug/commlmh.dll and /dev/null differ
diff --git a/SallyConnect/bin/Debug/commmhworker.dll b/SallyConnect/bin/Debug/commmhworker.dll
deleted file mode 100644
index 6a023ae7710ccf6df28253b15e81c03d2b4ca682..0000000000000000000000000000000000000000
Binary files a/SallyConnect/bin/Debug/commmhworker.dll and /dev/null differ
diff --git a/SallyConnect/bin/Debug/commplanetaryclient.dll b/SallyConnect/bin/Debug/commplanetaryclient.dll
deleted file mode 100644
index dc7ba985719f6462fab5b6e6fbd1fe856080dbb2..0000000000000000000000000000000000000000
Binary files a/SallyConnect/bin/Debug/commplanetaryclient.dll and /dev/null differ
diff --git a/SallyConnect/bin/Debug/commtheo.dll b/SallyConnect/bin/Debug/commtheo.dll
deleted file mode 100644
index ae190ab5d5a9a8de51d96ebe302f18e8a415b698..0000000000000000000000000000000000000000
Binary files a/SallyConnect/bin/Debug/commtheo.dll and /dev/null differ
diff --git a/SallyConnect/bin/Debug/log4net.dll b/SallyConnect/bin/Debug/log4net.dll
deleted file mode 100644
index 47cd9ad41bd21c765693ef396831e01a13f80f8f..0000000000000000000000000000000000000000
Binary files a/SallyConnect/bin/Debug/log4net.dll and /dev/null differ
diff --git a/SallyConnect/bin/Debug/log4net.xml b/SallyConnect/bin/Debug/log4net.xml
deleted file mode 100644
index 55a19f255f2716ba51c500b36be12ffb02490e9f..0000000000000000000000000000000000000000
--- a/SallyConnect/bin/Debug/log4net.xml
+++ /dev/null
@@ -1,31814 +0,0 @@
-<?xml version="1.0"?>
-<doc>
- <assembly>
- <name>log4net</name>
- </assembly>
- <members>
- <member name="T:log4net.Appender.AdoNetAppender">
- <summary>
- Appender that logs to a database.
- </summary>
- <remarks>
- <para>
- <see cref="T:log4net.Appender.AdoNetAppender"/> appends logging events to a table within a
- database. The appender can be configured to specify the connection
- string by setting the <see cref="P:log4net.Appender.AdoNetAppender.ConnectionString"/> property.
- The connection type (provider) can be specified by setting the <see cref="P:log4net.Appender.AdoNetAppender.ConnectionType"/>
- property. For more information on database connection strings for
- your specific database see <a href="http://www.connectionstrings.com/">http://www.connectionstrings.com/</a>.
- </para>
- <para>
- Records are written into the database either using a prepared
- statement or a stored procedure. The <see cref="P:log4net.Appender.AdoNetAppender.CommandType"/> property
- is set to <see cref="F:System.Data.CommandType.Text"/> (<c>System.Data.CommandType.Text</c>) to specify a prepared statement
- or to <see cref="F:System.Data.CommandType.StoredProcedure"/> (<c>System.Data.CommandType.StoredProcedure</c>) to specify a stored
- procedure.
- </para>
- <para>
- The prepared statement text or the name of the stored procedure
- must be set in the <see cref="P:log4net.Appender.AdoNetAppender.CommandText"/> property.
- </para>
- <para>
- The prepared statement or stored procedure can take a number
- of parameters. Parameters are added using the <see cref="M:log4net.Appender.AdoNetAppender.AddParameter(log4net.Appender.AdoNetAppenderParameter)"/>
- method. This adds a single <see cref="T:log4net.Appender.AdoNetAppenderParameter"/> to the
- ordered list of parameters. The <see cref="T:log4net.Appender.AdoNetAppenderParameter"/>
- type may be subclassed if required to provide database specific
- functionality. The <see cref="T:log4net.Appender.AdoNetAppenderParameter"/> specifies
- the parameter name, database type, size, and how the value should
- be generated using a <see cref="T:log4net.Layout.ILayout"/>.
- </para>
- </remarks>
- <example>
- An example of a SQL Server table that could be logged to:
- <code lang="SQL">
- CREATE TABLE [dbo].[Log] (
- [ID] [int] IDENTITY (1, 1) NOT NULL ,
- [Date] [datetime] NOT NULL ,
- [Thread] [varchar] (255) NOT NULL ,
- [Level] [varchar] (20) NOT NULL ,
- [Logger] [varchar] (255) NOT NULL ,
- [Message] [varchar] (4000) NOT NULL
- ) ON [PRIMARY]
- </code>
- </example>
- <example>
- An example configuration to log to the above table:
- <code lang="XML" escaped="true">
- <appender name="AdoNetAppender_SqlServer" type="log4net.Appender.AdoNetAppender">
- <connectionType value="System.Data.SqlClient.SqlConnection, System.Data, Version=1.0.3300.0, Culture=neutral, PublicKeyToken=b77a5c561934e089"/>
- <connectionString value="data source=SQLSVR;initial catalog=test_log4net;integrated security=false;persist security info=True;User ID=sa;Password=sa"/>
- <commandText value="INSERT INTO Log ([Date],[Thread],[Level],[Logger],[Message]) VALUES (@log_date, @thread, @log_level, @logger, @message)"/>
- <parameter>
- <parameterName value="@log_date"/>
- <dbType value="DateTime"/>
- <layout type="log4net.Layout.PatternLayout" value="%date{yyyy'-'MM'-'dd HH':'mm':'ss'.'fff}"/>
- </parameter>
- <parameter>
- <parameterName value="@thread"/>
- <dbType value="String"/>
- <size value="255"/>
- <layout type="log4net.Layout.PatternLayout" value="%thread"/>
- </parameter>
- <parameter>
- <parameterName value="@log_level"/>
- <dbType value="String"/>
- <size value="50"/>
- <layout type="log4net.Layout.PatternLayout" value="%level"/>
- </parameter>
- <parameter>
- <parameterName value="@logger"/>
- <dbType value="String"/>
- <size value="255"/>
- <layout type="log4net.Layout.PatternLayout" value="%logger"/>
- </parameter>
- <parameter>
- <parameterName value="@message"/>
- <dbType value="String"/>
- <size value="4000"/>
- <layout type="log4net.Layout.PatternLayout" value="%message"/>
- </parameter>
- </appender>
- </code>
- </example>
- <author>Julian Biddle</author>
- <author>Nicko Cadell</author>
- <author>Gert Driesen</author>
- <author>Lance Nehring</author>
- </member>
- <member name="T:log4net.Appender.BufferingAppenderSkeleton">
- <summary>
- Abstract base class implementation of <see cref="T:log4net.Appender.IAppender"/> that
- buffers events in a fixed size buffer.
- </summary>
- <remarks>
- <para>
- This base class should be used by appenders that need to buffer a
- number of events before logging them. For example the <see cref="T:log4net.Appender.AdoNetAppender"/>
- buffers events and then submits the entire contents of the buffer to
- the underlying database in one go.
- </para>
- <para>
- Subclasses should override the <see cref="M:SendBuffer(LoggingEvent[])"/>
- method to deliver the buffered events.
- </para>
- <para>The BufferingAppenderSkeleton maintains a fixed size cyclic
- buffer of events. The size of the buffer is set using
- the <see cref="P:log4net.Appender.BufferingAppenderSkeleton.BufferSize"/> property.
- </para>
- <para>A <see cref="T:log4net.Core.ITriggeringEventEvaluator"/> is used to inspect
- each event as it arrives in the appender. If the <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Evaluator"/>
- triggers, then the current buffer is sent immediately
- (see <see cref="M:SendBuffer(LoggingEvent[])"/>). Otherwise the event
- is stored in the buffer. For example, an evaluator can be used to
- deliver the events immediately when an ERROR event arrives.
- </para>
- <para>
- The buffering appender can be configured in a <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Lossy"/> mode.
- By default the appender is NOT lossy. When the buffer is full all
- the buffered events are sent with <see cref="M:SendBuffer(LoggingEvent[])"/>.
- If the <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Lossy"/> property is set to <c>true</c> then the
- buffer will not be sent when it is full, and new events arriving
- in the appender will overwrite the oldest event in the buffer.
- In lossy mode the buffer will only be sent when the <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Evaluator"/>
- triggers. This can be useful behavior when you need to know about
- ERROR events but not about events with a lower level, configure an
- evaluator that will trigger when an ERROR event arrives, the whole
- buffer will be sent which gives a history of events leading up to
- the ERROR event.
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- <author>Gert Driesen</author>
- </member>
- <member name="T:log4net.Appender.AppenderSkeleton">
- <summary>
- Abstract base class implementation of <see cref="T:log4net.Appender.IAppender"/>.
- </summary>
- <remarks>
- <para>
- This class provides the code for common functionality, such
- as support for threshold filtering and support for general filters.
- </para>
- <para>
- Appenders can also implement the <see cref="T:log4net.Core.IOptionHandler"/> interface. Therefore
- they would require that the <see cref="M:IOptionHandler.ActivateOptions()"/> method
- be called after the appenders properties have been configured.
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- <author>Gert Driesen</author>
- </member>
- <member name="T:log4net.Appender.IAppender">
- <summary>
- Implement this interface for your own strategies for printing log statements.
- </summary>
- <remarks>
- <para>
- Implementors should consider extending the <see cref="T:log4net.Appender.AppenderSkeleton"/>
- class which provides a default implementation of this interface.
- </para>
- <para>
- Appenders can also implement the <see cref="T:log4net.Core.IOptionHandler"/> interface. Therefore
- they would require that the <see cref="M:IOptionHandler.ActivateOptions()"/> method
- be called after the appenders properties have been configured.
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- <author>Gert Driesen</author>
- </member>
- <member name="M:log4net.Appender.IAppender.Close">
- <summary>
- Closes the appender and releases resources.
- </summary>
- <remarks>
- <para>
- Releases any resources allocated within the appender such as file handles,
- network connections, etc.
- </para>
- <para>
- It is a programming error to append to a closed appender.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.IAppender.DoAppend(log4net.Core.LoggingEvent)">
- <summary>
- Log the logging event in Appender specific way.
- </summary>
- <param name="loggingEvent">The event to log</param>
- <remarks>
- <para>
- This method is called to log a message into this appender.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Appender.IAppender.Name">
- <summary>
- Gets or sets the name of this appender.
- </summary>
- <value>The name of the appender.</value>
- <remarks>
- <para>The name uniquely identifies the appender.</para>
- </remarks>
- </member>
- <member name="T:log4net.Appender.IBulkAppender">
- <summary>
- Interface for appenders that support bulk logging.
- </summary>
- <remarks>
- <para>
- This interface extends the <see cref="T:log4net.Appender.IAppender"/> interface to
- support bulk logging of <see cref="T:log4net.Core.LoggingEvent"/> objects. Appenders
- should only implement this interface if they can bulk log efficiently.
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- </member>
- <member name="M:log4net.Appender.IBulkAppender.DoAppend(log4net.Core.LoggingEvent[])">
- <summary>
- Log the array of logging events in Appender specific way.
- </summary>
- <param name="loggingEvents">The events to log</param>
- <remarks>
- <para>
- This method is called to log an array of events into this appender.
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Core.IOptionHandler">
- <summary>
- Interface used to delay activate a configured object.
- </summary>
- <remarks>
- <para>
- This allows an object to defer activation of its options until all
- options have been set. This is required for components which have
- related options that remain ambiguous until all are set.
- </para>
- <para>
- If a component implements this interface then the <see cref="M:log4net.Core.IOptionHandler.ActivateOptions"/> method
- must be called by the container after its all the configured properties have been set
- and before the component can be used.
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- </member>
- <member name="M:log4net.Core.IOptionHandler.ActivateOptions">
- <summary>
- Activate the options that were previously set with calls to properties.
- </summary>
- <remarks>
- <para>
- This allows an object to defer activation of its options until all
- options have been set. This is required for components which have
- related options that remain ambiguous until all are set.
- </para>
- <para>
- If a component implements this interface then this method must be called
- after its properties have been set before the component can be used.
- </para>
- </remarks>
- </member>
- <member name="F:log4net.Appender.AppenderSkeleton.c_renderBufferSize">
- <summary>
- Initial buffer size
- </summary>
- </member>
- <member name="F:log4net.Appender.AppenderSkeleton.c_renderBufferMaxCapacity">
- <summary>
- Maximum buffer size before it is recycled
- </summary>
- </member>
- <member name="M:log4net.Appender.AppenderSkeleton.#ctor">
- <summary>
- Default constructor
- </summary>
- <remarks>
- <para>Empty default constructor</para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.AppenderSkeleton.Finalize">
- <summary>
- Finalizes this appender by calling the implementation's
- <see cref="M:log4net.Appender.AppenderSkeleton.Close"/> method.
- </summary>
- <remarks>
- <para>
- If this appender has not been closed then the <c>Finalize</c> method
- will call <see cref="M:log4net.Appender.AppenderSkeleton.Close"/>.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.AppenderSkeleton.ActivateOptions">
- <summary>
- Initialize the appender based on the options set
- </summary>
- <remarks>
- <para>
- This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
- activation scheme. The <see cref="M:log4net.Appender.AppenderSkeleton.ActivateOptions"/> method must
- be called on this object after the configuration properties have
- been set. Until <see cref="M:log4net.Appender.AppenderSkeleton.ActivateOptions"/> is called this
- object is in an undefined state and must not be used.
- </para>
- <para>
- If any of the configuration properties are modified then
- <see cref="M:log4net.Appender.AppenderSkeleton.ActivateOptions"/> must be called again.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.AppenderSkeleton.Close">
- <summary>
- Closes the appender and release resources.
- </summary>
- <remarks>
- <para>
- Release any resources allocated within the appender such as file handles,
- network connections, etc.
- </para>
- <para>
- It is a programming error to append to a closed appender.
- </para>
- <para>
- This method cannot be overridden by subclasses. This method
- delegates the closing of the appender to the <see cref="M:log4net.Appender.AppenderSkeleton.OnClose"/>
- method which must be overridden in the subclass.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.AppenderSkeleton.DoAppend(log4net.Core.LoggingEvent)">
- <summary>
- Performs threshold checks and invokes filters before
- delegating actual logging to the subclasses specific
- <see cref="M:Append(LoggingEvent)"/> method.
- </summary>
- <param name="loggingEvent">The event to log.</param>
- <remarks>
- <para>
- This method cannot be overridden by derived classes. A
- derived class should override the <see cref="M:Append(LoggingEvent)"/> method
- which is called by this method.
- </para>
- <para>
- The implementation of this method is as follows:
- </para>
- <para>
- <list type="bullet">
- <item>
- <description>
- Checks that the severity of the <paramref name="loggingEvent"/>
- is greater than or equal to the <see cref="P:log4net.Appender.AppenderSkeleton.Threshold"/> of this
- appender.</description>
- </item>
- <item>
- <description>
- Checks that the <see cref="T:log4net.Filter.IFilter"/> chain accepts the
- <paramref name="loggingEvent"/>.
- </description>
- </item>
- <item>
- <description>
- Calls <see cref="M:PreAppendCheck()"/> and checks that
- it returns <c>true</c>.</description>
- </item>
- </list>
- </para>
- <para>
- If all of the above steps succeed then the <paramref name="loggingEvent"/>
- will be passed to the abstract <see cref="M:Append(LoggingEvent)"/> method.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.AppenderSkeleton.DoAppend(log4net.Core.LoggingEvent[])">
- <summary>
- Performs threshold checks and invokes filters before
- delegating actual logging to the subclasses specific
- <see cref="M:Append(LoggingEvent[])"/> method.
- </summary>
- <param name="loggingEvents">The array of events to log.</param>
- <remarks>
- <para>
- This method cannot be overridden by derived classes. A
- derived class should override the <see cref="M:Append(LoggingEvent[])"/> method
- which is called by this method.
- </para>
- <para>
- The implementation of this method is as follows:
- </para>
- <para>
- <list type="bullet">
- <item>
- <description>
- Checks that the severity of the <paramref name="loggingEvents"/>
- is greater than or equal to the <see cref="P:log4net.Appender.AppenderSkeleton.Threshold"/> of this
- appender.</description>
- </item>
- <item>
- <description>
- Checks that the <see cref="T:log4net.Filter.IFilter"/> chain accepts the
- <paramref name="loggingEvents"/>.
- </description>
- </item>
- <item>
- <description>
- Calls <see cref="M:PreAppendCheck()"/> and checks that
- it returns <c>true</c>.</description>
- </item>
- </list>
- </para>
- <para>
- If all of the above steps succeed then the <paramref name="loggingEvents"/>
- will be passed to the <see cref="M:Append(LoggingEvent[])"/> method.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.AppenderSkeleton.FilterEvent(log4net.Core.LoggingEvent)">
- <summary>
- Test if the logging event should we output by this appender
- </summary>
- <param name="loggingEvent">the event to test</param>
- <returns><c>true</c> if the event should be output, <c>false</c> if the event should be ignored</returns>
- <remarks>
- <para>
- This method checks the logging event against the threshold level set
- on this appender and also against the filters specified on this
- appender.
- </para>
- <para>
- The implementation of this method is as follows:
- </para>
- <para>
- <list type="bullet">
- <item>
- <description>
- Checks that the severity of the <paramref name="loggingEvent"/>
- is greater than or equal to the <see cref="P:log4net.Appender.AppenderSkeleton.Threshold"/> of this
- appender.</description>
- </item>
- <item>
- <description>
- Checks that the <see cref="T:log4net.Filter.IFilter"/> chain accepts the
- <paramref name="loggingEvent"/>.
- </description>
- </item>
- </list>
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.AppenderSkeleton.AddFilter(log4net.Filter.IFilter)">
- <summary>
- Adds a filter to the end of the filter chain.
- </summary>
- <param name="filter">the filter to add to this appender</param>
- <remarks>
- <para>
- The Filters are organized in a linked list.
- </para>
- <para>
- Setting this property causes the new filter to be pushed onto the
- back of the filter chain.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.AppenderSkeleton.ClearFilters">
- <summary>
- Clears the filter list for this appender.
- </summary>
- <remarks>
- <para>
- Clears the filter list for this appender.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.AppenderSkeleton.IsAsSevereAsThreshold(log4net.Core.Level)">
- <summary>
- Checks if the message level is below this appender's threshold.
- </summary>
- <param name="level"><see cref="T:log4net.Core.Level"/> to test against.</param>
- <remarks>
- <para>
- If there is no threshold set, then the return value is always <c>true</c>.
- </para>
- </remarks>
- <returns>
- <c>true</c> if the <paramref name="level"/> meets the <see cref="P:log4net.Appender.AppenderSkeleton.Threshold"/>
- requirements of this appender.
- </returns>
- </member>
- <member name="M:log4net.Appender.AppenderSkeleton.OnClose">
- <summary>
- Is called when the appender is closed. Derived classes should override
- this method if resources need to be released.
- </summary>
- <remarks>
- <para>
- Releases any resources allocated within the appender such as file handles,
- network connections, etc.
- </para>
- <para>
- It is a programming error to append to a closed appender.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.AppenderSkeleton.Append(log4net.Core.LoggingEvent)">
- <summary>
- Subclasses of <see cref="T:log4net.Appender.AppenderSkeleton"/> should implement this method
- to perform actual logging.
- </summary>
- <param name="loggingEvent">The event to append.</param>
- <remarks>
- <para>
- A subclass must implement this method to perform
- logging of the <paramref name="loggingEvent"/>.
- </para>
- <para>This method will be called by <see cref="M:DoAppend(LoggingEvent)"/>
- if all the conditions listed for that method are met.
- </para>
- <para>
- To restrict the logging of events in the appender
- override the <see cref="M:PreAppendCheck()"/> method.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.AppenderSkeleton.Append(log4net.Core.LoggingEvent[])">
- <summary>
- Append a bulk array of logging events.
- </summary>
- <param name="loggingEvents">the array of logging events</param>
- <remarks>
- <para>
- This base class implementation calls the <see cref="M:Append(LoggingEvent)"/>
- method for each element in the bulk array.
- </para>
- <para>
- A sub class that can better process a bulk array of events should
- override this method in addition to <see cref="M:Append(LoggingEvent)"/>.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.AppenderSkeleton.PreAppendCheck">
- <summary>
- Called before <see cref="M:Append(LoggingEvent)"/> as a precondition.
- </summary>
- <remarks>
- <para>
- This method is called by <see cref="M:DoAppend(LoggingEvent)"/>
- before the call to the abstract <see cref="M:Append(LoggingEvent)"/> method.
- </para>
- <para>
- This method can be overridden in a subclass to extend the checks
- made before the event is passed to the <see cref="M:Append(LoggingEvent)"/> method.
- </para>
- <para>
- A subclass should ensure that they delegate this call to
- this base class if it is overridden.
- </para>
- </remarks>
- <returns><c>true</c> if the call to <see cref="M:Append(LoggingEvent)"/> should proceed.</returns>
- </member>
- <member name="M:log4net.Appender.AppenderSkeleton.RenderLoggingEvent(log4net.Core.LoggingEvent)">
- <summary>
- Renders the <see cref="T:log4net.Core.LoggingEvent"/> to a string.
- </summary>
- <param name="loggingEvent">The event to render.</param>
- <returns>The event rendered as a string.</returns>
- <remarks>
- <para>
- Helper method to render a <see cref="T:log4net.Core.LoggingEvent"/> to
- a string. This appender must have a <see cref="P:log4net.Appender.AppenderSkeleton.Layout"/>
- set to render the <paramref name="loggingEvent"/> to
- a string.
- </para>
- <para>If there is exception data in the logging event and
- the layout does not process the exception, this method
- will append the exception text to the rendered string.
- </para>
- <para>
- Where possible use the alternative version of this method
- <see cref="M:RenderLoggingEvent(TextWriter,LoggingEvent)"/>.
- That method streams the rendering onto an existing Writer
- which can give better performance if the caller already has
- a <see cref="T:System.IO.TextWriter"/> open and ready for writing.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.AppenderSkeleton.RenderLoggingEvent(System.IO.TextWriter,log4net.Core.LoggingEvent)">
- <summary>
- Renders the <see cref="T:log4net.Core.LoggingEvent"/> to a string.
- </summary>
- <param name="loggingEvent">The event to render.</param>
- <param name="writer">The TextWriter to write the formatted event to</param>
- <remarks>
- <para>
- Helper method to render a <see cref="T:log4net.Core.LoggingEvent"/> to
- a string. This appender must have a <see cref="P:log4net.Appender.AppenderSkeleton.Layout"/>
- set to render the <paramref name="loggingEvent"/> to
- a string.
- </para>
- <para>If there is exception data in the logging event and
- the layout does not process the exception, this method
- will append the exception text to the rendered string.
- </para>
- <para>
- Use this method in preference to <see cref="M:RenderLoggingEvent(LoggingEvent)"/>
- where possible. If, however, the caller needs to render the event
- to a string then <see cref="M:RenderLoggingEvent(LoggingEvent)"/> does
- provide an efficient mechanism for doing so.
- </para>
- </remarks>
- </member>
- <member name="F:log4net.Appender.AppenderSkeleton.m_layout">
- <summary>
- The layout of this appender.
- </summary>
- <remarks>
- See <see cref="P:log4net.Appender.AppenderSkeleton.Layout"/> for more information.
- </remarks>
- </member>
- <member name="F:log4net.Appender.AppenderSkeleton.m_name">
- <summary>
- The name of this appender.
- </summary>
- <remarks>
- See <see cref="P:log4net.Appender.AppenderSkeleton.Name"/> for more information.
- </remarks>
- </member>
- <member name="F:log4net.Appender.AppenderSkeleton.m_threshold">
- <summary>
- The level threshold of this appender.
- </summary>
- <remarks>
- <para>
- There is no level threshold filtering by default.
- </para>
- <para>
- See <see cref="P:log4net.Appender.AppenderSkeleton.Threshold"/> for more information.
- </para>
- </remarks>
- </member>
- <member name="F:log4net.Appender.AppenderSkeleton.m_errorHandler">
- <summary>
- It is assumed and enforced that errorHandler is never null.
- </summary>
- <remarks>
- <para>
- It is assumed and enforced that errorHandler is never null.
- </para>
- <para>
- See <see cref="P:log4net.Appender.AppenderSkeleton.ErrorHandler"/> for more information.
- </para>
- </remarks>
- </member>
- <member name="F:log4net.Appender.AppenderSkeleton.m_headFilter">
- <summary>
- The first filter in the filter chain.
- </summary>
- <remarks>
- <para>
- Set to <c>null</c> initially.
- </para>
- <para>
- See <see cref="T:log4net.Filter.IFilter"/> for more information.
- </para>
- </remarks>
- </member>
- <member name="F:log4net.Appender.AppenderSkeleton.m_tailFilter">
- <summary>
- The last filter in the filter chain.
- </summary>
- <remarks>
- See <see cref="T:log4net.Filter.IFilter"/> for more information.
- </remarks>
- </member>
- <member name="F:log4net.Appender.AppenderSkeleton.m_closed">
- <summary>
- Flag indicating if this appender is closed.
- </summary>
- <remarks>
- See <see cref="M:log4net.Appender.AppenderSkeleton.Close"/> for more information.
- </remarks>
- </member>
- <member name="F:log4net.Appender.AppenderSkeleton.m_recursiveGuard">
- <summary>
- The guard prevents an appender from repeatedly calling its own DoAppend method
- </summary>
- </member>
- <member name="F:log4net.Appender.AppenderSkeleton.m_renderWriter">
- <summary>
- StringWriter used to render events
- </summary>
- </member>
- <member name="F:log4net.Appender.AppenderSkeleton.declaringType">
- <summary>
- The fully qualified type of the AppenderSkeleton class.
- </summary>
- <remarks>
- Used by the internal logger to record the Type of the
- log message.
- </remarks>
- </member>
- <member name="P:log4net.Appender.AppenderSkeleton.Threshold">
- <summary>
- Gets or sets the threshold <see cref="T:log4net.Core.Level"/> of this appender.
- </summary>
- <value>
- The threshold <see cref="T:log4net.Core.Level"/> of the appender.
- </value>
- <remarks>
- <para>
- All log events with lower level than the threshold level are ignored
- by the appender.
- </para>
- <para>
- In configuration files this option is specified by setting the
- value of the <see cref="P:log4net.Appender.AppenderSkeleton.Threshold"/> option to a level
- string, such as "DEBUG", "INFO" and so on.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Appender.AppenderSkeleton.ErrorHandler">
- <summary>
- Gets or sets the <see cref="T:log4net.Core.IErrorHandler"/> for this appender.
- </summary>
- <value>The <see cref="T:log4net.Core.IErrorHandler"/> of the appender</value>
- <remarks>
- <para>
- The <see cref="T:log4net.Appender.AppenderSkeleton"/> provides a default
- implementation for the <see cref="P:log4net.Appender.AppenderSkeleton.ErrorHandler"/> property.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Appender.AppenderSkeleton.FilterHead">
- <summary>
- The filter chain.
- </summary>
- <value>The head of the filter chain filter chain.</value>
- <remarks>
- <para>
- Returns the head Filter. The Filters are organized in a linked list
- and so all Filters on this Appender are available through the result.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Appender.AppenderSkeleton.Layout">
- <summary>
- Gets or sets the <see cref="T:log4net.Layout.ILayout"/> for this appender.
- </summary>
- <value>The layout of the appender.</value>
- <remarks>
- <para>
- See <see cref="P:log4net.Appender.AppenderSkeleton.RequiresLayout"/> for more information.
- </para>
- </remarks>
- <seealso cref="P:log4net.Appender.AppenderSkeleton.RequiresLayout"/>
- </member>
- <member name="P:log4net.Appender.AppenderSkeleton.Name">
- <summary>
- Gets or sets the name of this appender.
- </summary>
- <value>The name of the appender.</value>
- <remarks>
- <para>
- The name uniquely identifies the appender.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Appender.AppenderSkeleton.RequiresLayout">
- <summary>
- Tests if this appender requires a <see cref="P:log4net.Appender.AppenderSkeleton.Layout"/> to be set.
- </summary>
- <remarks>
- <para>
- In the rather exceptional case, where the appender
- implementation admits a layout but can also work without it,
- then the appender should return <c>true</c>.
- </para>
- <para>
- This default implementation always returns <c>false</c>.
- </para>
- </remarks>
- <returns>
- <c>true</c> if the appender requires a layout object, otherwise <c>false</c>.
- </returns>
- </member>
- <member name="F:log4net.Appender.BufferingAppenderSkeleton.DEFAULT_BUFFER_SIZE">
- <summary>
- The default buffer size.
- </summary>
- <remarks>
- The default size of the cyclic buffer used to store events.
- This is set to 512 by default.
- </remarks>
- </member>
- <member name="M:log4net.Appender.BufferingAppenderSkeleton.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:log4net.Appender.BufferingAppenderSkeleton"/> class.
- </summary>
- <remarks>
- <para>
- Protected default constructor to allow subclassing.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.BufferingAppenderSkeleton.#ctor(System.Boolean)">
- <summary>
- Initializes a new instance of the <see cref="T:log4net.Appender.BufferingAppenderSkeleton"/> class.
- </summary>
- <param name="eventMustBeFixed">the events passed through this appender must be
- fixed by the time that they arrive in the derived class' <c>SendBuffer</c> method.</param>
- <remarks>
- <para>
- Protected constructor to allow subclassing.
- </para>
- <para>
- The <paramref name="eventMustBeFixed"/> should be set if the subclass
- expects the events delivered to be fixed even if the
- <see cref="P:log4net.Appender.BufferingAppenderSkeleton.BufferSize"/> is set to zero, i.e. when no buffering occurs.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.BufferingAppenderSkeleton.Flush">
- <summary>
- Flush the currently buffered events
- </summary>
- <remarks>
- <para>
- Flushes any events that have been buffered.
- </para>
- <para>
- If the appender is buffering in <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Lossy"/> mode then the contents
- of the buffer will NOT be flushed to the appender.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.BufferingAppenderSkeleton.Flush(System.Boolean)">
- <summary>
- Flush the currently buffered events
- </summary>
- <param name="flushLossyBuffer">set to <c>true</c> to flush the buffer of lossy events</param>
- <remarks>
- <para>
- Flushes events that have been buffered. If <paramref name="flushLossyBuffer"/> is
- <c>false</c> then events will only be flushed if this buffer is non-lossy mode.
- </para>
- <para>
- If the appender is buffering in <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Lossy"/> mode then the contents
- of the buffer will only be flushed if <paramref name="flushLossyBuffer"/> is <c>true</c>.
- In this case the contents of the buffer will be tested against the
- <see cref="P:log4net.Appender.BufferingAppenderSkeleton.LossyEvaluator"/> and if triggering will be output. All other buffered
- events will be discarded.
- </para>
- <para>
- If <paramref name="flushLossyBuffer"/> is <c>true</c> then the buffer will always
- be emptied by calling this method.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.BufferingAppenderSkeleton.ActivateOptions">
- <summary>
- Initialize the appender based on the options set
- </summary>
- <remarks>
- <para>
- This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
- activation scheme. The <see cref="M:log4net.Appender.BufferingAppenderSkeleton.ActivateOptions"/> method must
- be called on this object after the configuration properties have
- been set. Until <see cref="M:log4net.Appender.BufferingAppenderSkeleton.ActivateOptions"/> is called this
- object is in an undefined state and must not be used.
- </para>
- <para>
- If any of the configuration properties are modified then
- <see cref="M:log4net.Appender.BufferingAppenderSkeleton.ActivateOptions"/> must be called again.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.BufferingAppenderSkeleton.OnClose">
- <summary>
- Close this appender instance.
- </summary>
- <remarks>
- <para>
- Close this appender instance. If this appender is marked
- as not <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Lossy"/> then the remaining events in
- the buffer must be sent when the appender is closed.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.BufferingAppenderSkeleton.Append(log4net.Core.LoggingEvent)">
- <summary>
- This method is called by the <see cref="M:AppenderSkeleton.DoAppend(LoggingEvent)"/> method.
- </summary>
- <param name="loggingEvent">the event to log</param>
- <remarks>
- <para>
- Stores the <paramref name="loggingEvent"/> in the cyclic buffer.
- </para>
- <para>
- The buffer will be sent (i.e. passed to the <see cref="M:log4net.Appender.BufferingAppenderSkeleton.SendBuffer(log4net.Core.LoggingEvent[])"/>
- method) if one of the following conditions is met:
- </para>
- <list type="bullet">
- <item>
- <description>The cyclic buffer is full and this appender is
- marked as not lossy (see <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Lossy"/>)</description>
- </item>
- <item>
- <description>An <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Evaluator"/> is set and
- it is triggered for the <paramref name="loggingEvent"/>
- specified.</description>
- </item>
- </list>
- <para>
- Before the event is stored in the buffer it is fixed
- (see <see cref="M:LoggingEvent.FixVolatileData(FixFlags)"/>) to ensure that
- any data referenced by the event will be valid when the buffer
- is processed.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.BufferingAppenderSkeleton.SendFromBuffer(log4net.Core.LoggingEvent,log4net.Util.CyclicBuffer)">
- <summary>
- Sends the contents of the buffer.
- </summary>
- <param name="firstLoggingEvent">The first logging event.</param>
- <param name="buffer">The buffer containing the events that need to be send.</param>
- <remarks>
- <para>
- The subclass must override <see cref="M:SendBuffer(LoggingEvent[])"/>.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.BufferingAppenderSkeleton.SendBuffer(log4net.Core.LoggingEvent[])">
- <summary>
- Sends the events.
- </summary>
- <param name="events">The events that need to be send.</param>
- <remarks>
- <para>
- The subclass must override this method to process the buffered events.
- </para>
- </remarks>
- </member>
- <member name="F:log4net.Appender.BufferingAppenderSkeleton.m_bufferSize">
- <summary>
- The size of the cyclic buffer used to hold the logging events.
- </summary>
- <remarks>
- Set to <see cref="F:log4net.Appender.BufferingAppenderSkeleton.DEFAULT_BUFFER_SIZE"/> by default.
- </remarks>
- </member>
- <member name="F:log4net.Appender.BufferingAppenderSkeleton.m_cb">
- <summary>
- The cyclic buffer used to store the logging events.
- </summary>
- </member>
- <member name="F:log4net.Appender.BufferingAppenderSkeleton.m_evaluator">
- <summary>
- The triggering event evaluator that causes the buffer to be sent immediately.
- </summary>
- <remarks>
- The object that is used to determine if an event causes the entire
- buffer to be sent immediately. This field can be <c>null</c>, which
- indicates that event triggering is not to be done. The evaluator
- can be set using the <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Evaluator"/> property. If this appender
- has the <see cref="F:log4net.Appender.BufferingAppenderSkeleton.m_lossy"/> (<see cref="P:log4net.Appender.BufferingAppenderSkeleton.Lossy"/> property) set to
- <c>true</c> then an <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Evaluator"/> must be set.
- </remarks>
- </member>
- <member name="F:log4net.Appender.BufferingAppenderSkeleton.m_lossy">
- <summary>
- Indicates if the appender should overwrite events in the cyclic buffer
- when it becomes full, or if the buffer should be flushed when the
- buffer is full.
- </summary>
- <remarks>
- If this field is set to <c>true</c> then an <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Evaluator"/> must
- be set.
- </remarks>
- </member>
- <member name="F:log4net.Appender.BufferingAppenderSkeleton.m_lossyEvaluator">
- <summary>
- The triggering event evaluator filters discarded events.
- </summary>
- <remarks>
- The object that is used to determine if an event that is discarded should
- really be discarded or if it should be sent to the appenders.
- This field can be <c>null</c>, which indicates that all discarded events will
- be discarded.
- </remarks>
- </member>
- <member name="F:log4net.Appender.BufferingAppenderSkeleton.m_fixFlags">
- <summary>
- Value indicating which fields in the event should be fixed
- </summary>
- <remarks>
- By default all fields are fixed
- </remarks>
- </member>
- <member name="F:log4net.Appender.BufferingAppenderSkeleton.m_eventMustBeFixed">
- <summary>
- The events delivered to the subclass must be fixed.
- </summary>
- </member>
- <member name="P:log4net.Appender.BufferingAppenderSkeleton.Lossy">
- <summary>
- Gets or sets a value that indicates whether the appender is lossy.
- </summary>
- <value>
- <c>true</c> if the appender is lossy, otherwise <c>false</c>. The default is <c>false</c>.
- </value>
- <remarks>
- <para>
- This appender uses a buffer to store logging events before
- delivering them. A triggering event causes the whole buffer
- to be send to the remote sink. If the buffer overruns before
- a triggering event then logging events could be lost. Set
- <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Lossy"/> to <c>false</c> to prevent logging events
- from being lost.
- </para>
- <para>If <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Lossy"/> is set to <c>true</c> then an
- <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Evaluator"/> must be specified.</para>
- </remarks>
- </member>
- <member name="P:log4net.Appender.BufferingAppenderSkeleton.BufferSize">
- <summary>
- Gets or sets the size of the cyclic buffer used to hold the
- logging events.
- </summary>
- <value>
- The size of the cyclic buffer used to hold the logging events.
- </value>
- <remarks>
- <para>
- The <see cref="P:log4net.Appender.BufferingAppenderSkeleton.BufferSize"/> option takes a positive integer
- representing the maximum number of logging events to collect in
- a cyclic buffer. When the <see cref="P:log4net.Appender.BufferingAppenderSkeleton.BufferSize"/> is reached,
- oldest events are deleted as new events are added to the
- buffer. By default the size of the cyclic buffer is 512 events.
- </para>
- <para>
- If the <see cref="P:log4net.Appender.BufferingAppenderSkeleton.BufferSize"/> is set to a value less than
- or equal to 1 then no buffering will occur. The logging event
- will be delivered synchronously (depending on the <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Lossy"/>
- and <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Evaluator"/> properties). Otherwise the event will
- be buffered.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Appender.BufferingAppenderSkeleton.Evaluator">
- <summary>
- Gets or sets the <see cref="T:log4net.Core.ITriggeringEventEvaluator"/> that causes the
- buffer to be sent immediately.
- </summary>
- <value>
- The <see cref="T:log4net.Core.ITriggeringEventEvaluator"/> that causes the buffer to be
- sent immediately.
- </value>
- <remarks>
- <para>
- The evaluator will be called for each event that is appended to this
- appender. If the evaluator triggers then the current buffer will
- immediately be sent (see <see cref="M:SendBuffer(LoggingEvent[])"/>).
- </para>
- <para>If <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Lossy"/> is set to <c>true</c> then an
- <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Evaluator"/> must be specified.</para>
- </remarks>
- </member>
- <member name="P:log4net.Appender.BufferingAppenderSkeleton.LossyEvaluator">
- <summary>
- Gets or sets the value of the <see cref="T:log4net.Core.ITriggeringEventEvaluator"/> to use.
- </summary>
- <value>
- The value of the <see cref="T:log4net.Core.ITriggeringEventEvaluator"/> to use.
- </value>
- <remarks>
- <para>
- The evaluator will be called for each event that is discarded from this
- appender. If the evaluator triggers then the current buffer will immediately
- be sent (see <see cref="M:SendBuffer(LoggingEvent[])"/>).
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Appender.BufferingAppenderSkeleton.OnlyFixPartialEventData">
- <summary>
- Gets or sets a value indicating if only part of the logging event data
- should be fixed.
- </summary>
- <value>
- <c>true</c> if the appender should only fix part of the logging event
- data, otherwise <c>false</c>. The default is <c>false</c>.
- </value>
- <remarks>
- <para>
- Setting this property to <c>true</c> will cause only part of the
- event data to be fixed and serialized. This will improve performance.
- </para>
- <para>
- See <see cref="M:LoggingEvent.FixVolatileData(FixFlags)"/> for more information.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Appender.BufferingAppenderSkeleton.Fix">
- <summary>
- Gets or sets a the fields that will be fixed in the event
- </summary>
- <value>
- The event fields that will be fixed before the event is buffered
- </value>
- <remarks>
- <para>
- The logging event needs to have certain thread specific values
- captured before it can be buffered. See <see cref="P:log4net.Core.LoggingEvent.Fix"/>
- for details.
- </para>
- </remarks>
- <seealso cref="P:log4net.Core.LoggingEvent.Fix"/>
- </member>
- <member name="M:log4net.Appender.AdoNetAppender.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:log4net.Appender.AdoNetAppender"/> class.
- </summary>
- <remarks>
- Public default constructor to initialize a new instance of this class.
- </remarks>
- </member>
- <member name="M:log4net.Appender.AdoNetAppender.ActivateOptions">
- <summary>
- Initialize the appender based on the options set
- </summary>
- <remarks>
- <para>
- This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
- activation scheme. The <see cref="M:log4net.Appender.AdoNetAppender.ActivateOptions"/> method must
- be called on this object after the configuration properties have
- been set. Until <see cref="M:log4net.Appender.AdoNetAppender.ActivateOptions"/> is called this
- object is in an undefined state and must not be used.
- </para>
- <para>
- If any of the configuration properties are modified then
- <see cref="M:log4net.Appender.AdoNetAppender.ActivateOptions"/> must be called again.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.AdoNetAppender.OnClose">
- <summary>
- Override the parent method to close the database
- </summary>
- <remarks>
- <para>
- Closes the database command and database connection.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.AdoNetAppender.SendBuffer(log4net.Core.LoggingEvent[])">
- <summary>
- Inserts the events into the database.
- </summary>
- <param name="events">The events to insert into the database.</param>
- <remarks>
- <para>
- Insert all the events specified in the <paramref name="events"/>
- array into the database.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.AdoNetAppender.AddParameter(log4net.Appender.AdoNetAppenderParameter)">
- <summary>
- Adds a parameter to the command.
- </summary>
- <param name="parameter">The parameter to add to the command.</param>
- <remarks>
- <para>
- Adds a parameter to the ordered list of command parameters.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.AdoNetAppender.SendBuffer(System.Data.IDbTransaction,log4net.Core.LoggingEvent[])">
- <summary>
- Writes the events to the database using the transaction specified.
- </summary>
- <param name="dbTran">The transaction that the events will be executed under.</param>
- <param name="events">The array of events to insert into the database.</param>
- <remarks>
- <para>
- The transaction argument can be <c>null</c> if the appender has been
- configured not to use transactions. See <see cref="P:log4net.Appender.AdoNetAppender.UseTransactions"/>
- property for more information.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.AdoNetAppender.GetLogStatement(log4net.Core.LoggingEvent)">
- <summary>
- Formats the log message into database statement text.
- </summary>
- <param name="logEvent">The event being logged.</param>
- <remarks>
- This method can be overridden by subclasses to provide
- more control over the format of the database statement.
- </remarks>
- <returns>
- Text that can be passed to a <see cref="T:System.Data.IDbCommand"/>.
- </returns>
- </member>
- <member name="M:log4net.Appender.AdoNetAppender.CreateConnection(System.Type,System.String)">
- <summary>
- Creates an <see cref="T:System.Data.IDbConnection"/> instance used to connect to the database.
- </summary>
- <remarks>
- This method is called whenever a new IDbConnection is needed (i.e. when a reconnect is necessary).
- </remarks>
- <param name="connectionType">The <see cref="T:System.Type"/> of the <see cref="T:System.Data.IDbConnection"/> object.</param>
- <param name="connectionString">The connectionString output from the ResolveConnectionString method.</param>
- <returns>An <see cref="T:System.Data.IDbConnection"/> instance with a valid connection string.</returns>
- </member>
- <member name="M:log4net.Appender.AdoNetAppender.ResolveConnectionString(System.String@)">
- <summary>
- Resolves the connection string from the ConnectionString, ConnectionStringName, or AppSettingsKey
- property.
- </summary>
- <remarks>
- ConnectiongStringName is only supported on .NET 2.0 and higher.
- </remarks>
- <param name="connectionStringContext">Additional information describing the connection string.</param>
- <returns>A connection string used to connect to the database.</returns>
- </member>
- <member name="M:log4net.Appender.AdoNetAppender.ResolveConnectionType">
- <summary>
- Retrieves the class type of the ADO.NET provider.
- </summary>
- <remarks>
- <para>
- Gets the Type of the ADO.NET provider to use to connect to the
- database. This method resolves the type specified in the
- <see cref="P:log4net.Appender.AdoNetAppender.ConnectionType"/> property.
- </para>
- <para>
- Subclasses can override this method to return a different type
- if necessary.
- </para>
- </remarks>
- <returns>The <see cref="T:System.Type"/> of the ADO.NET provider</returns>
- </member>
- <member name="M:log4net.Appender.AdoNetAppender.InitializeDatabaseCommand">
- <summary>
- Prepares the database command and initialize the parameters.
- </summary>
- </member>
- <member name="M:log4net.Appender.AdoNetAppender.InitializeDatabaseConnection">
- <summary>
- Connects to the database.
- </summary>
- </member>
- <member name="M:log4net.Appender.AdoNetAppender.DisposeCommand(System.Boolean)">
- <summary>
- Cleanup the existing command.
- </summary>
- <param name="ignoreException">
- If true, a message will be written using LogLog.Warn if an exception is encountered when calling Dispose.
- </param>
- </member>
- <member name="M:log4net.Appender.AdoNetAppender.DiposeConnection">
- <summary>
- Cleanup the existing connection.
- </summary>
- <remarks>
- Calls the IDbConnection's <see cref="M:System.Data.IDbConnection.Close"/> method.
- </remarks>
- </member>
- <member name="F:log4net.Appender.AdoNetAppender.m_usePreparedCommand">
- <summary>
- Flag to indicate if we are using a command object
- </summary>
- <remarks>
- <para>
- Set to <c>true</c> when the appender is to use a prepared
- statement or stored procedure to insert into the database.
- </para>
- </remarks>
- </member>
- <member name="F:log4net.Appender.AdoNetAppender.m_parameters">
- <summary>
- The list of <see cref="T:log4net.Appender.AdoNetAppenderParameter"/> objects.
- </summary>
- <remarks>
- <para>
- The list of <see cref="T:log4net.Appender.AdoNetAppenderParameter"/> objects.
- </para>
- </remarks>
- </member>
- <member name="F:log4net.Appender.AdoNetAppender.m_securityContext">
- <summary>
- The security context to use for privileged calls
- </summary>
- </member>
- <member name="F:log4net.Appender.AdoNetAppender.m_dbConnection">
- <summary>
- The <see cref="T:System.Data.IDbConnection"/> that will be used
- to insert logging events into a database.
- </summary>
- </member>
- <member name="F:log4net.Appender.AdoNetAppender.m_dbCommand">
- <summary>
- The database command.
- </summary>
- </member>
- <member name="F:log4net.Appender.AdoNetAppender.m_connectionString">
- <summary>
- Database connection string.
- </summary>
- </member>
- <member name="F:log4net.Appender.AdoNetAppender.m_appSettingsKey">
- <summary>
- The appSettings key from App.Config that contains the connection string.
- </summary>
- </member>
- <member name="F:log4net.Appender.AdoNetAppender.m_connectionStringName">
- <summary>
- The connectionStrings key from App.Config that contains the connection string.
- </summary>
- </member>
- <member name="F:log4net.Appender.AdoNetAppender.m_connectionType">
- <summary>
- String type name of the <see cref="T:System.Data.IDbConnection"/> type name.
- </summary>
- </member>
- <member name="F:log4net.Appender.AdoNetAppender.m_commandText">
- <summary>
- The text of the command.
- </summary>
- </member>
- <member name="F:log4net.Appender.AdoNetAppender.m_commandType">
- <summary>
- The command type.
- </summary>
- </member>
- <member name="F:log4net.Appender.AdoNetAppender.m_useTransactions">
- <summary>
- Indicates whether to use transactions when writing to the database.
- </summary>
- </member>
- <member name="F:log4net.Appender.AdoNetAppender.m_reconnectOnError">
- <summary>
- Indicates whether to use transactions when writing to the database.
- </summary>
- </member>
- <member name="F:log4net.Appender.AdoNetAppender.declaringType">
- <summary>
- The fully qualified type of the AdoNetAppender class.
- </summary>
- <remarks>
- Used by the internal logger to record the Type of the
- log message.
- </remarks>
- </member>
- <member name="P:log4net.Appender.AdoNetAppender.ConnectionString">
- <summary>
- Gets or sets the database connection string that is used to connect to
- the database.
- </summary>
- <value>
- The database connection string used to connect to the database.
- </value>
- <remarks>
- <para>
- The connections string is specific to the connection type.
- See <see cref="P:log4net.Appender.AdoNetAppender.ConnectionType"/> for more information.
- </para>
- </remarks>
- <example>Connection string for MS Access via ODBC:
- <code>"DSN=MS Access Database;UID=admin;PWD=;SystemDB=C:\data\System.mdw;SafeTransactions = 0;FIL=MS Access;DriverID = 25;DBQ=C:\data\train33.mdb"</code>
- </example>
- <example>Another connection string for MS Access via ODBC:
- <code>"Driver={Microsoft Access Driver (*.mdb)};DBQ=C:\Work\cvs_root\log4net-1.2\access.mdb;UID=;PWD=;"</code>
- </example>
- <example>Connection string for MS Access via OLE DB:
- <code>"Provider=Microsoft.Jet.OLEDB.4.0;Data Source=C:\Work\cvs_root\log4net-1.2\access.mdb;User Id=;Password=;"</code>
- </example>
- </member>
- <member name="P:log4net.Appender.AdoNetAppender.AppSettingsKey">
- <summary>
- The appSettings key from App.Config that contains the connection string.
- </summary>
- </member>
- <member name="P:log4net.Appender.AdoNetAppender.ConnectionStringName">
- <summary>
- The connectionStrings key from App.Config that contains the connection string.
- </summary>
- <remarks>
- This property requires at least .NET 2.0.
- </remarks>
- </member>
- <member name="P:log4net.Appender.AdoNetAppender.ConnectionType">
- <summary>
- Gets or sets the type name of the <see cref="T:System.Data.IDbConnection"/> connection
- that should be created.
- </summary>
- <value>
- The type name of the <see cref="T:System.Data.IDbConnection"/> connection.
- </value>
- <remarks>
- <para>
- The type name of the ADO.NET provider to use.
- </para>
- <para>
- The default is to use the OLE DB provider.
- </para>
- </remarks>
- <example>Use the OLE DB Provider. This is the default value.
- <code>System.Data.OleDb.OleDbConnection, System.Data, Version=1.0.3300.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</code>
- </example>
- <example>Use the MS SQL Server Provider.
- <code>System.Data.SqlClient.SqlConnection, System.Data, Version=1.0.3300.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</code>
- </example>
- <example>Use the ODBC Provider.
- <code>Microsoft.Data.Odbc.OdbcConnection,Microsoft.Data.Odbc,version=1.0.3300.0,publicKeyToken=b77a5c561934e089,culture=neutral</code>
- This is an optional package that you can download from
- <a href="http://msdn.microsoft.com/downloads">http://msdn.microsoft.com/downloads</a>
- search for <b>ODBC .NET Data Provider</b>.
- </example>
- <example>Use the Oracle Provider.
- <code>System.Data.OracleClient.OracleConnection, System.Data.OracleClient, Version=1.0.3300.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</code>
- This is an optional package that you can download from
- <a href="http://msdn.microsoft.com/downloads">http://msdn.microsoft.com/downloads</a>
- search for <b>.NET Managed Provider for Oracle</b>.
- </example>
- </member>
- <member name="P:log4net.Appender.AdoNetAppender.CommandText">
- <summary>
- Gets or sets the command text that is used to insert logging events
- into the database.
- </summary>
- <value>
- The command text used to insert logging events into the database.
- </value>
- <remarks>
- <para>
- Either the text of the prepared statement or the
- name of the stored procedure to execute to write into
- the database.
- </para>
- <para>
- The <see cref="P:log4net.Appender.AdoNetAppender.CommandType"/> property determines if
- this text is a prepared statement or a stored procedure.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Appender.AdoNetAppender.CommandType">
- <summary>
- Gets or sets the command type to execute.
- </summary>
- <value>
- The command type to execute.
- </value>
- <remarks>
- <para>
- This value may be either <see cref="F:System.Data.CommandType.Text"/> (<c>System.Data.CommandType.Text</c>) to specify
- that the <see cref="P:log4net.Appender.AdoNetAppender.CommandText"/> is a prepared statement to execute,
- or <see cref="F:System.Data.CommandType.StoredProcedure"/> (<c>System.Data.CommandType.StoredProcedure</c>) to specify that the
- <see cref="P:log4net.Appender.AdoNetAppender.CommandText"/> property is the name of a stored procedure
- to execute.
- </para>
- <para>
- The default value is <see cref="F:System.Data.CommandType.Text"/> (<c>System.Data.CommandType.Text</c>).
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Appender.AdoNetAppender.UseTransactions">
- <summary>
- Should transactions be used to insert logging events in the database.
- </summary>
- <value>
- <c>true</c> if transactions should be used to insert logging events in
- the database, otherwise <c>false</c>. The default value is <c>true</c>.
- </value>
- <remarks>
- <para>
- Gets or sets a value that indicates whether transactions should be used
- to insert logging events in the database.
- </para>
- <para>
- When set a single transaction will be used to insert the buffered events
- into the database. Otherwise each event will be inserted without using
- an explicit transaction.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Appender.AdoNetAppender.SecurityContext">
- <summary>
- Gets or sets the <see cref="P:log4net.Appender.AdoNetAppender.SecurityContext"/> used to call the NetSend method.
- </summary>
- <value>
- The <see cref="P:log4net.Appender.AdoNetAppender.SecurityContext"/> used to call the NetSend method.
- </value>
- <remarks>
- <para>
- Unless a <see cref="P:log4net.Appender.AdoNetAppender.SecurityContext"/> specified here for this appender
- the <see cref="P:log4net.Core.SecurityContextProvider.DefaultProvider"/> is queried for the
- security context to use. The default behavior is to use the security context
- of the current thread.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Appender.AdoNetAppender.ReconnectOnError">
- <summary>
- Should this appender try to reconnect to the database on error.
- </summary>
- <value>
- <c>true</c> if the appender should try to reconnect to the database after an
- error has occurred, otherwise <c>false</c>. The default value is <c>false</c>,
- i.e. not to try to reconnect.
- </value>
- <remarks>
- <para>
- The default behaviour is for the appender not to try to reconnect to the
- database if an error occurs. Subsequent logging events are discarded.
- </para>
- <para>
- To force the appender to attempt to reconnect to the database set this
- property to <c>true</c>.
- </para>
- <note>
- When the appender attempts to connect to the database there may be a
- delay of up to the connection timeout specified in the connection string.
- This delay will block the calling application's thread.
- Until the connection can be reestablished this potential delay may occur multiple times.
- </note>
- </remarks>
- </member>
- <member name="P:log4net.Appender.AdoNetAppender.Connection">
- <summary>
- Gets or sets the underlying <see cref="T:System.Data.IDbConnection"/>.
- </summary>
- <value>
- The underlying <see cref="T:System.Data.IDbConnection"/>.
- </value>
- <remarks>
- <see cref="T:log4net.Appender.AdoNetAppender"/> creates a <see cref="T:System.Data.IDbConnection"/> to insert
- logging events into a database. Classes deriving from <see cref="T:log4net.Appender.AdoNetAppender"/>
- can use this property to get or set this <see cref="T:System.Data.IDbConnection"/>. Use the
- underlying <see cref="T:System.Data.IDbConnection"/> returned from <see cref="P:log4net.Appender.AdoNetAppender.Connection"/> if
- you require access beyond that which <see cref="T:log4net.Appender.AdoNetAppender"/> provides.
- </remarks>
- </member>
- <member name="T:log4net.Appender.AdoNetAppenderParameter">
- <summary>
- Parameter type used by the <see cref="T:log4net.Appender.AdoNetAppender"/>.
- </summary>
- <remarks>
- <para>
- This class provides the basic database parameter properties
- as defined by the <see cref="T:System.Data.IDbDataParameter"/> interface.
- </para>
- <para>This type can be subclassed to provide database specific
- functionality. The two methods that are called externally are
- <see cref="M:log4net.Appender.AdoNetAppenderParameter.Prepare(System.Data.IDbCommand)"/> and <see cref="M:log4net.Appender.AdoNetAppenderParameter.FormatValue(System.Data.IDbCommand,log4net.Core.LoggingEvent)"/>.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.AdoNetAppenderParameter.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:log4net.Appender.AdoNetAppenderParameter"/> class.
- </summary>
- <remarks>
- Default constructor for the AdoNetAppenderParameter class.
- </remarks>
- </member>
- <member name="M:log4net.Appender.AdoNetAppenderParameter.Prepare(System.Data.IDbCommand)">
- <summary>
- Prepare the specified database command object.
- </summary>
- <param name="command">The command to prepare.</param>
- <remarks>
- <para>
- Prepares the database command object by adding
- this parameter to its collection of parameters.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.AdoNetAppenderParameter.FormatValue(System.Data.IDbCommand,log4net.Core.LoggingEvent)">
- <summary>
- Renders the logging event and set the parameter value in the command.
- </summary>
- <param name="command">The command containing the parameter.</param>
- <param name="loggingEvent">The event to be rendered.</param>
- <remarks>
- <para>
- Renders the logging event using this parameters layout
- object. Sets the value of the parameter on the command object.
- </para>
- </remarks>
- </member>
- <member name="F:log4net.Appender.AdoNetAppenderParameter.m_parameterName">
- <summary>
- The name of this parameter.
- </summary>
- </member>
- <member name="F:log4net.Appender.AdoNetAppenderParameter.m_dbType">
- <summary>
- The database type for this parameter.
- </summary>
- </member>
- <member name="F:log4net.Appender.AdoNetAppenderParameter.m_inferType">
- <summary>
- Flag to infer type rather than use the DbType
- </summary>
- </member>
- <member name="F:log4net.Appender.AdoNetAppenderParameter.m_precision">
- <summary>
- The precision for this parameter.
- </summary>
- </member>
- <member name="F:log4net.Appender.AdoNetAppenderParameter.m_scale">
- <summary>
- The scale for this parameter.
- </summary>
- </member>
- <member name="F:log4net.Appender.AdoNetAppenderParameter.m_size">
- <summary>
- The size for this parameter.
- </summary>
- </member>
- <member name="F:log4net.Appender.AdoNetAppenderParameter.m_layout">
- <summary>
- The <see cref="T:log4net.Layout.IRawLayout"/> to use to render the
- logging event into an object for this parameter.
- </summary>
- </member>
- <member name="P:log4net.Appender.AdoNetAppenderParameter.ParameterName">
- <summary>
- Gets or sets the name of this parameter.
- </summary>
- <value>
- The name of this parameter.
- </value>
- <remarks>
- <para>
- The name of this parameter. The parameter name
- must match up to a named parameter to the SQL stored procedure
- or prepared statement.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Appender.AdoNetAppenderParameter.DbType">
- <summary>
- Gets or sets the database type for this parameter.
- </summary>
- <value>
- The database type for this parameter.
- </value>
- <remarks>
- <para>
- The database type for this parameter. This property should
- be set to the database type from the <see cref="P:log4net.Appender.AdoNetAppenderParameter.DbType"/>
- enumeration. See <see cref="P:System.Data.IDataParameter.DbType"/>.
- </para>
- <para>
- This property is optional. If not specified the ADO.NET provider
- will attempt to infer the type from the value.
- </para>
- </remarks>
- <seealso cref="P:System.Data.IDataParameter.DbType"/>
- </member>
- <member name="P:log4net.Appender.AdoNetAppenderParameter.Precision">
- <summary>
- Gets or sets the precision for this parameter.
- </summary>
- <value>
- The precision for this parameter.
- </value>
- <remarks>
- <para>
- The maximum number of digits used to represent the Value.
- </para>
- <para>
- This property is optional. If not specified the ADO.NET provider
- will attempt to infer the precision from the value.
- </para>
- </remarks>
- <seealso cref="P:System.Data.IDbDataParameter.Precision"/>
- </member>
- <member name="P:log4net.Appender.AdoNetAppenderParameter.Scale">
- <summary>
- Gets or sets the scale for this parameter.
- </summary>
- <value>
- The scale for this parameter.
- </value>
- <remarks>
- <para>
- The number of decimal places to which Value is resolved.
- </para>
- <para>
- This property is optional. If not specified the ADO.NET provider
- will attempt to infer the scale from the value.
- </para>
- </remarks>
- <seealso cref="P:System.Data.IDbDataParameter.Scale"/>
- </member>
- <member name="P:log4net.Appender.AdoNetAppenderParameter.Size">
- <summary>
- Gets or sets the size for this parameter.
- </summary>
- <value>
- The size for this parameter.
- </value>
- <remarks>
- <para>
- The maximum size, in bytes, of the data within the column.
- </para>
- <para>
- This property is optional. If not specified the ADO.NET provider
- will attempt to infer the size from the value.
- </para>
- <para>
- For BLOB data types like VARCHAR(max) it may be impossible to infer the value automatically, use -1 as the size in this case.
- </para>
- </remarks>
- <seealso cref="P:System.Data.IDbDataParameter.Size"/>
- </member>
- <member name="P:log4net.Appender.AdoNetAppenderParameter.Layout">
- <summary>
- Gets or sets the <see cref="T:log4net.Layout.IRawLayout"/> to use to
- render the logging event into an object for this
- parameter.
- </summary>
- <value>
- The <see cref="T:log4net.Layout.IRawLayout"/> used to render the
- logging event into an object for this parameter.
- </value>
- <remarks>
- <para>
- The <see cref="T:log4net.Layout.IRawLayout"/> that renders the value for this
- parameter.
- </para>
- <para>
- The <see cref="T:log4net.Layout.RawLayoutConverter"/> can be used to adapt
- any <see cref="T:log4net.Layout.ILayout"/> into a <see cref="T:log4net.Layout.IRawLayout"/>
- for use in the property.
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Appender.AnsiColorTerminalAppender">
- <summary>
- Appends logging events to the terminal using ANSI color escape sequences.
- </summary>
- <remarks>
- <para>
- AnsiColorTerminalAppender appends log events to the standard output stream
- or the error output stream using a layout specified by the
- user. It also allows the color of a specific level of message to be set.
- </para>
- <note>
- This appender expects the terminal to understand the VT100 control set
- in order to interpret the color codes. If the terminal or console does not
- understand the control codes the behavior is not defined.
- </note>
- <para>
- By default, all output is written to the console's standard output stream.
- The <see cref="P:log4net.Appender.AnsiColorTerminalAppender.Target"/> property can be set to direct the output to the
- error stream.
- </para>
- <para>
- NOTE: This appender writes each message to the <c>System.Console.Out</c> or
- <c>System.Console.Error</c> that is set at the time the event is appended.
- Therefore it is possible to programmatically redirect the output of this appender
- (for example NUnit does this to capture program output). While this is the desired
- behavior of this appender it may have security implications in your application.
- </para>
- <para>
- When configuring the ANSI colored terminal appender, a mapping should be
- specified to map a logging level to a color. For example:
- </para>
- <code lang="XML" escaped="true">
- <mapping>
- <level value="ERROR"/>
- <foreColor value="White"/>
- <backColor value="Red"/>
- <attributes value="Bright,Underscore"/>
- </mapping>
- <mapping>
- <level value="DEBUG"/>
- <backColor value="Green"/>
- </mapping>
- </code>
- <para>
- The Level is the standard log4net logging level and ForeColor and BackColor can be any
- of the following values:
- <list type="bullet">
- <item><term>Blue</term><description></description></item>
- <item><term>Green</term><description></description></item>
- <item><term>Red</term><description></description></item>
- <item><term>White</term><description></description></item>
- <item><term>Yellow</term><description></description></item>
- <item><term>Purple</term><description></description></item>
- <item><term>Cyan</term><description></description></item>
- </list>
- These color values cannot be combined together to make new colors.
- </para>
- <para>
- The attributes can be any combination of the following:
- <list type="bullet">
- <item><term>Bright</term><description>foreground is brighter</description></item>
- <item><term>Dim</term><description>foreground is dimmer</description></item>
- <item><term>Underscore</term><description>message is underlined</description></item>
- <item><term>Blink</term><description>foreground is blinking (does not work on all terminals)</description></item>
- <item><term>Reverse</term><description>foreground and background are reversed</description></item>
- <item><term>Hidden</term><description>output is hidden</description></item>
- <item><term>Strikethrough</term><description>message has a line through it</description></item>
- </list>
- While any of these attributes may be combined together not all combinations
- work well together, for example setting both <i>Bright</i> and <i>Dim</i> attributes makes
- no sense.
- </para>
- </remarks>
- <author>Patrick Wagstrom</author>
- <author>Nicko Cadell</author>
- </member>
- <member name="F:log4net.Appender.AnsiColorTerminalAppender.ConsoleOut">
- <summary>
- The <see cref="P:log4net.Appender.AnsiColorTerminalAppender.Target"/> to use when writing to the Console
- standard output stream.
- </summary>
- <remarks>
- <para>
- The <see cref="P:log4net.Appender.AnsiColorTerminalAppender.Target"/> to use when writing to the Console
- standard output stream.
- </para>
- </remarks>
- </member>
- <member name="F:log4net.Appender.AnsiColorTerminalAppender.ConsoleError">
- <summary>
- The <see cref="P:log4net.Appender.AnsiColorTerminalAppender.Target"/> to use when writing to the Console
- standard error output stream.
- </summary>
- <remarks>
- <para>
- The <see cref="P:log4net.Appender.AnsiColorTerminalAppender.Target"/> to use when writing to the Console
- standard error output stream.
- </para>
- </remarks>
- </member>
- <member name="F:log4net.Appender.AnsiColorTerminalAppender.PostEventCodes">
- <summary>
- Ansi code to reset terminal
- </summary>
- </member>
- <member name="M:log4net.Appender.AnsiColorTerminalAppender.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:log4net.Appender.AnsiColorTerminalAppender"/> class.
- </summary>
- <remarks>
- The instance of the <see cref="T:log4net.Appender.AnsiColorTerminalAppender"/> class is set up to write
- to the standard output stream.
- </remarks>
- </member>
- <member name="M:log4net.Appender.AnsiColorTerminalAppender.AddMapping(log4net.Appender.AnsiColorTerminalAppender.LevelColors)">
- <summary>
- Add a mapping of level to color
- </summary>
- <param name="mapping">The mapping to add</param>
- <remarks>
- <para>
- Add a <see cref="T:log4net.Appender.AnsiColorTerminalAppender.LevelColors"/> mapping to this appender.
- Each mapping defines the foreground and background colours
- for a level.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.AnsiColorTerminalAppender.Append(log4net.Core.LoggingEvent)">
- <summary>
- This method is called by the <see cref="M:AppenderSkeleton.DoAppend(LoggingEvent)"/> method.
- </summary>
- <param name="loggingEvent">The event to log.</param>
- <remarks>
- <para>
- Writes the event to the console.
- </para>
- <para>
- The format of the output will depend on the appender's layout.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.AnsiColorTerminalAppender.ActivateOptions">
- <summary>
- Initialize the options for this appender
- </summary>
- <remarks>
- <para>
- Initialize the level to color mappings set on this appender.
- </para>
- </remarks>
- </member>
- <member name="F:log4net.Appender.AnsiColorTerminalAppender.m_writeToErrorStream">
- <summary>
- Flag to write output to the error stream rather than the standard output stream
- </summary>
- </member>
- <member name="F:log4net.Appender.AnsiColorTerminalAppender.m_levelMapping">
- <summary>
- Mapping from level object to color value
- </summary>
- </member>
- <member name="P:log4net.Appender.AnsiColorTerminalAppender.Target">
- <summary>
- Target is the value of the console output stream.
- </summary>
- <value>
- Target is the value of the console output stream.
- This is either <c>"Console.Out"</c> or <c>"Console.Error"</c>.
- </value>
- <remarks>
- <para>
- Target is the value of the console output stream.
- This is either <c>"Console.Out"</c> or <c>"Console.Error"</c>.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Appender.AnsiColorTerminalAppender.RequiresLayout">
- <summary>
- This appender requires a <see cref="N:log4net.Layout"/> to be set.
- </summary>
- <value><c>true</c></value>
- <remarks>
- <para>
- This appender requires a <see cref="N:log4net.Layout"/> to be set.
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Appender.AnsiColorTerminalAppender.AnsiAttributes">
- <summary>
- The enum of possible display attributes
- </summary>
- <remarks>
- <para>
- The following flags can be combined together to
- form the ANSI color attributes.
- </para>
- </remarks>
- <seealso cref="T:log4net.Appender.AnsiColorTerminalAppender"/>
- </member>
- <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiAttributes.Bright">
- <summary>
- text is bright
- </summary>
- </member>
- <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiAttributes.Dim">
- <summary>
- text is dim
- </summary>
- </member>
- <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiAttributes.Underscore">
- <summary>
- text is underlined
- </summary>
- </member>
- <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiAttributes.Blink">
- <summary>
- text is blinking
- </summary>
- <remarks>
- Not all terminals support this attribute
- </remarks>
- </member>
- <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiAttributes.Reverse">
- <summary>
- text and background colors are reversed
- </summary>
- </member>
- <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiAttributes.Hidden">
- <summary>
- text is hidden
- </summary>
- </member>
- <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiAttributes.Strikethrough">
- <summary>
- text is displayed with a strikethrough
- </summary>
- </member>
- <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiAttributes.Light">
- <summary>
- text color is light
- </summary>
- </member>
- <member name="T:log4net.Appender.AnsiColorTerminalAppender.AnsiColor">
- <summary>
- The enum of possible foreground or background color values for
- use with the color mapping method
- </summary>
- <remarks>
- <para>
- The output can be in one for the following ANSI colors.
- </para>
- </remarks>
- <seealso cref="T:log4net.Appender.AnsiColorTerminalAppender"/>
- </member>
- <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiColor.Black">
- <summary>
- color is black
- </summary>
- </member>
- <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiColor.Red">
- <summary>
- color is red
- </summary>
- </member>
- <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiColor.Green">
- <summary>
- color is green
- </summary>
- </member>
- <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiColor.Yellow">
- <summary>
- color is yellow
- </summary>
- </member>
- <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiColor.Blue">
- <summary>
- color is blue
- </summary>
- </member>
- <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiColor.Magenta">
- <summary>
- color is magenta
- </summary>
- </member>
- <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiColor.Cyan">
- <summary>
- color is cyan
- </summary>
- </member>
- <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiColor.White">
- <summary>
- color is white
- </summary>
- </member>
- <member name="T:log4net.Appender.AnsiColorTerminalAppender.LevelColors">
- <summary>
- A class to act as a mapping between the level that a logging call is made at and
- the color it should be displayed as.
- </summary>
- <remarks>
- <para>
- Defines the mapping between a level and the color it should be displayed in.
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Util.LevelMappingEntry">
- <summary>
- An entry in the <see cref="T:log4net.Util.LevelMapping"/>
- </summary>
- <remarks>
- <para>
- This is an abstract base class for types that are stored in the
- <see cref="T:log4net.Util.LevelMapping"/> object.
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- </member>
- <member name="M:log4net.Util.LevelMappingEntry.#ctor">
- <summary>
- Default protected constructor
- </summary>
- <remarks>
- <para>
- Default protected constructor
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.LevelMappingEntry.ActivateOptions">
- <summary>
- Initialize any options defined on this entry
- </summary>
- <remarks>
- <para>
- Should be overridden by any classes that need to initialise based on their options
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Util.LevelMappingEntry.Level">
- <summary>
- The level that is the key for this mapping
- </summary>
- <value>
- The <see cref="P:log4net.Util.LevelMappingEntry.Level"/> that is the key for this mapping
- </value>
- <remarks>
- <para>
- Get or set the <see cref="P:log4net.Util.LevelMappingEntry.Level"/> that is the key for this
- mapping subclass.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.AnsiColorTerminalAppender.LevelColors.ActivateOptions">
- <summary>
- Initialize the options for the object
- </summary>
- <remarks>
- <para>
- Combine the <see cref="P:log4net.Appender.AnsiColorTerminalAppender.LevelColors.ForeColor"/> and <see cref="P:log4net.Appender.AnsiColorTerminalAppender.LevelColors.BackColor"/> together
- and append the attributes.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Appender.AnsiColorTerminalAppender.LevelColors.ForeColor">
- <summary>
- The mapped foreground color for the specified level
- </summary>
- <remarks>
- <para>
- Required property.
- The mapped foreground color for the specified level
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Appender.AnsiColorTerminalAppender.LevelColors.BackColor">
- <summary>
- The mapped background color for the specified level
- </summary>
- <remarks>
- <para>
- Required property.
- The mapped background color for the specified level
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Appender.AnsiColorTerminalAppender.LevelColors.Attributes">
- <summary>
- The color attributes for the specified level
- </summary>
- <remarks>
- <para>
- Required property.
- The color attributes for the specified level
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Appender.AnsiColorTerminalAppender.LevelColors.CombinedColor">
- <summary>
- The combined <see cref="P:log4net.Appender.AnsiColorTerminalAppender.LevelColors.ForeColor"/>, <see cref="P:log4net.Appender.AnsiColorTerminalAppender.LevelColors.BackColor"/> and
- <see cref="P:log4net.Appender.AnsiColorTerminalAppender.LevelColors.Attributes"/> suitable for setting the ansi terminal color.
- </summary>
- </member>
- <member name="T:log4net.Appender.AppenderCollection">
- <summary>
- A strongly-typed collection of <see cref="T:log4net.Appender.IAppender"/> objects.
- </summary>
- <author>Nicko Cadell</author>
- </member>
- <member name="M:log4net.Appender.AppenderCollection.ReadOnly(log4net.Appender.AppenderCollection)">
- <summary>
- Creates a read-only wrapper for a <c>AppenderCollection</c> instance.
- </summary>
- <param name="list">list to create a readonly wrapper arround</param>
- <returns>
- An <c>AppenderCollection</c> wrapper that is read-only.
- </returns>
- </member>
- <member name="F:log4net.Appender.AppenderCollection.EmptyCollection">
- <summary>
- An empty readonly static AppenderCollection
- </summary>
- </member>
- <member name="M:log4net.Appender.AppenderCollection.#ctor">
- <summary>
- Initializes a new instance of the <c>AppenderCollection</c> class
- that is empty and has the default initial capacity.
- </summary>
- </member>
- <member name="M:log4net.Appender.AppenderCollection.#ctor(System.Int32)">
- <summary>
- Initializes a new instance of the <c>AppenderCollection</c> class
- that has the specified initial capacity.
- </summary>
- <param name="capacity">
- The number of elements that the new <c>AppenderCollection</c> is initially capable of storing.
- </param>
- </member>
- <member name="M:log4net.Appender.AppenderCollection.#ctor(log4net.Appender.AppenderCollection)">
- <summary>
- Initializes a new instance of the <c>AppenderCollection</c> class
- that contains elements copied from the specified <c>AppenderCollection</c>.
- </summary>
- <param name="c">The <c>AppenderCollection</c> whose elements are copied to the new collection.</param>
- </member>
- <member name="M:log4net.Appender.AppenderCollection.#ctor(log4net.Appender.IAppender[])">
- <summary>
- Initializes a new instance of the <c>AppenderCollection</c> class
- that contains elements copied from the specified <see cref="T:log4net.Appender.IAppender"/> array.
- </summary>
- <param name="a">The <see cref="T:log4net.Appender.IAppender"/> array whose elements are copied to the new list.</param>
- </member>
- <member name="M:log4net.Appender.AppenderCollection.#ctor(System.Collections.ICollection)">
- <summary>
- Initializes a new instance of the <c>AppenderCollection</c> class
- that contains elements copied from the specified <see cref="T:log4net.Appender.IAppender"/> collection.
- </summary>
- <param name="col">The <see cref="T:log4net.Appender.IAppender"/> collection whose elements are copied to the new list.</param>
- </member>
- <member name="M:log4net.Appender.AppenderCollection.#ctor(log4net.Appender.AppenderCollection.Tag)">
- <summary>
- Allow subclasses to avoid our default constructors
- </summary>
- <param name="tag"></param>
- <exclude/>
- </member>
- <member name="M:log4net.Appender.AppenderCollection.CopyTo(log4net.Appender.IAppender[])">
- <summary>
- Copies the entire <c>AppenderCollection</c> to a one-dimensional
- <see cref="T:log4net.Appender.IAppender"/> array.
- </summary>
- <param name="array">The one-dimensional <see cref="T:log4net.Appender.IAppender"/> array to copy to.</param>
- </member>
- <member name="M:log4net.Appender.AppenderCollection.CopyTo(log4net.Appender.IAppender[],System.Int32)">
- <summary>
- Copies the entire <c>AppenderCollection</c> to a one-dimensional
- <see cref="T:log4net.Appender.IAppender"/> array, starting at the specified index of the target array.
- </summary>
- <param name="array">The one-dimensional <see cref="T:log4net.Appender.IAppender"/> array to copy to.</param>
- <param name="start">The zero-based index in <paramref name="array"/> at which copying begins.</param>
- </member>
- <member name="M:log4net.Appender.AppenderCollection.Add(log4net.Appender.IAppender)">
- <summary>
- Adds a <see cref="T:log4net.Appender.IAppender"/> to the end of the <c>AppenderCollection</c>.
- </summary>
- <param name="item">The <see cref="T:log4net.Appender.IAppender"/> to be added to the end of the <c>AppenderCollection</c>.</param>
- <returns>The index at which the value has been added.</returns>
- </member>
- <member name="M:log4net.Appender.AppenderCollection.Clear">
- <summary>
- Removes all elements from the <c>AppenderCollection</c>.
- </summary>
- </member>
- <member name="M:log4net.Appender.AppenderCollection.Clone">
- <summary>
- Creates a shallow copy of the <see cref="T:log4net.Appender.AppenderCollection"/>.
- </summary>
- <returns>A new <see cref="T:log4net.Appender.AppenderCollection"/> with a shallow copy of the collection data.</returns>
- </member>
- <member name="M:log4net.Appender.AppenderCollection.Contains(log4net.Appender.IAppender)">
- <summary>
- Determines whether a given <see cref="T:log4net.Appender.IAppender"/> is in the <c>AppenderCollection</c>.
- </summary>
- <param name="item">The <see cref="T:log4net.Appender.IAppender"/> to check for.</param>
- <returns><c>true</c> if <paramref name="item"/> is found in the <c>AppenderCollection</c>; otherwise, <c>false</c>.</returns>
- </member>
- <member name="M:log4net.Appender.AppenderCollection.IndexOf(log4net.Appender.IAppender)">
- <summary>
- Returns the zero-based index of the first occurrence of a <see cref="T:log4net.Appender.IAppender"/>
- in the <c>AppenderCollection</c>.
- </summary>
- <param name="item">The <see cref="T:log4net.Appender.IAppender"/> to locate in the <c>AppenderCollection</c>.</param>
- <returns>
- The zero-based index of the first occurrence of <paramref name="item"/>
- in the entire <c>AppenderCollection</c>, if found; otherwise, -1.
- </returns>
- </member>
- <member name="M:log4net.Appender.AppenderCollection.Insert(System.Int32,log4net.Appender.IAppender)">
- <summary>
- Inserts an element into the <c>AppenderCollection</c> at the specified index.
- </summary>
- <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
- <param name="item">The <see cref="T:log4net.Appender.IAppender"/> to insert.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="index"/> is less than zero</para>
- <para>-or-</para>
- <para><paramref name="index"/> is equal to or greater than <see cref="P:log4net.Appender.AppenderCollection.Count"/>.</para>
- </exception>
- </member>
- <member name="M:log4net.Appender.AppenderCollection.Remove(log4net.Appender.IAppender)">
- <summary>
- Removes the first occurrence of a specific <see cref="T:log4net.Appender.IAppender"/> from the <c>AppenderCollection</c>.
- </summary>
- <param name="item">The <see cref="T:log4net.Appender.IAppender"/> to remove from the <c>AppenderCollection</c>.</param>
- <exception cref="T:System.ArgumentException">
- The specified <see cref="T:log4net.Appender.IAppender"/> was not found in the <c>AppenderCollection</c>.
- </exception>
- </member>
- <member name="M:log4net.Appender.AppenderCollection.RemoveAt(System.Int32)">
- <summary>
- Removes the element at the specified index of the <c>AppenderCollection</c>.
- </summary>
- <param name="index">The zero-based index of the element to remove.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="index"/> is less than zero</para>
- <para>-or-</para>
- <para><paramref name="index"/> is equal to or greater than <see cref="P:log4net.Appender.AppenderCollection.Count"/>.</para>
- </exception>
- </member>
- <member name="M:log4net.Appender.AppenderCollection.GetEnumerator">
- <summary>
- Returns an enumerator that can iterate through the <c>AppenderCollection</c>.
- </summary>
- <returns>An <see cref="T:log4net.Appender.AppenderCollection.Enumerator"/> for the entire <c>AppenderCollection</c>.</returns>
- </member>
- <member name="M:log4net.Appender.AppenderCollection.AddRange(log4net.Appender.AppenderCollection)">
- <summary>
- Adds the elements of another <c>AppenderCollection</c> to the current <c>AppenderCollection</c>.
- </summary>
- <param name="x">The <c>AppenderCollection</c> whose elements should be added to the end of the current <c>AppenderCollection</c>.</param>
- <returns>The new <see cref="P:log4net.Appender.AppenderCollection.Count"/> of the <c>AppenderCollection</c>.</returns>
- </member>
- <member name="M:log4net.Appender.AppenderCollection.AddRange(log4net.Appender.IAppender[])">
- <summary>
- Adds the elements of a <see cref="T:log4net.Appender.IAppender"/> array to the current <c>AppenderCollection</c>.
- </summary>
- <param name="x">The <see cref="T:log4net.Appender.IAppender"/> array whose elements should be added to the end of the <c>AppenderCollection</c>.</param>
- <returns>The new <see cref="P:log4net.Appender.AppenderCollection.Count"/> of the <c>AppenderCollection</c>.</returns>
- </member>
- <member name="M:log4net.Appender.AppenderCollection.AddRange(System.Collections.ICollection)">
- <summary>
- Adds the elements of a <see cref="T:log4net.Appender.IAppender"/> collection to the current <c>AppenderCollection</c>.
- </summary>
- <param name="col">The <see cref="T:log4net.Appender.IAppender"/> collection whose elements should be added to the end of the <c>AppenderCollection</c>.</param>
- <returns>The new <see cref="P:log4net.Appender.AppenderCollection.Count"/> of the <c>AppenderCollection</c>.</returns>
- </member>
- <member name="M:log4net.Appender.AppenderCollection.TrimToSize">
- <summary>
- Sets the capacity to the actual number of elements.
- </summary>
- </member>
- <member name="M:log4net.Appender.AppenderCollection.ToArray">
- <summary>
- Return the collection elements as an array
- </summary>
- <returns>the array</returns>
- </member>
- <member name="M:log4net.Appender.AppenderCollection.ValidateIndex(System.Int32)">
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="i"/> is less than zero</para>
- <para>-or-</para>
- <para><paramref name="i"/> is equal to or greater than <see cref="P:log4net.Appender.AppenderCollection.Count"/>.</para>
- </exception>
- </member>
- <member name="M:log4net.Appender.AppenderCollection.ValidateIndex(System.Int32,System.Boolean)">
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="i"/> is less than zero</para>
- <para>-or-</para>
- <para><paramref name="i"/> is equal to or greater than <see cref="P:log4net.Appender.AppenderCollection.Count"/>.</para>
- </exception>
- </member>
- <member name="P:log4net.Appender.AppenderCollection.Count">
- <summary>
- Gets the number of elements actually contained in the <c>AppenderCollection</c>.
- </summary>
- </member>
- <member name="P:log4net.Appender.AppenderCollection.IsSynchronized">
- <summary>
- Gets a value indicating whether access to the collection is synchronized (thread-safe).
- </summary>
- <returns>true if access to the ICollection is synchronized (thread-safe); otherwise, false.</returns>
- </member>
- <member name="P:log4net.Appender.AppenderCollection.SyncRoot">
- <summary>
- Gets an object that can be used to synchronize access to the collection.
- </summary>
- </member>
- <member name="P:log4net.Appender.AppenderCollection.Item(System.Int32)">
- <summary>
- Gets or sets the <see cref="T:log4net.Appender.IAppender"/> at the specified index.
- </summary>
- <param name="index">The zero-based index of the element to get or set.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="index"/> is less than zero</para>
- <para>-or-</para>
- <para><paramref name="index"/> is equal to or greater than <see cref="P:log4net.Appender.AppenderCollection.Count"/>.</para>
- </exception>
- </member>
- <member name="P:log4net.Appender.AppenderCollection.IsFixedSize">
- <summary>
- Gets a value indicating whether the collection has a fixed size.
- </summary>
- <value>true if the collection has a fixed size; otherwise, false. The default is false</value>
- </member>
- <member name="P:log4net.Appender.AppenderCollection.IsReadOnly">
- <summary>
- Gets a value indicating whether the IList is read-only.
- </summary>
- <value>true if the collection is read-only; otherwise, false. The default is false</value>
- </member>
- <member name="P:log4net.Appender.AppenderCollection.Capacity">
- <summary>
- Gets or sets the number of elements the <c>AppenderCollection</c> can contain.
- </summary>
- </member>
- <member name="T:log4net.Appender.AppenderCollection.IAppenderCollectionEnumerator">
- <summary>
- Supports type-safe iteration over a <see cref="T:log4net.Appender.AppenderCollection"/>.
- </summary>
- <exclude/>
- </member>
- <member name="M:log4net.Appender.AppenderCollection.IAppenderCollectionEnumerator.MoveNext">
- <summary>
- Advances the enumerator to the next element in the collection.
- </summary>
- <returns>
- <c>true</c> if the enumerator was successfully advanced to the next element;
- <c>false</c> if the enumerator has passed the end of the collection.
- </returns>
- <exception cref="T:System.InvalidOperationException">
- The collection was modified after the enumerator was created.
- </exception>
- </member>
- <member name="M:log4net.Appender.AppenderCollection.IAppenderCollectionEnumerator.Reset">
- <summary>
- Sets the enumerator to its initial position, before the first element in the collection.
- </summary>
- </member>
- <member name="P:log4net.Appender.AppenderCollection.IAppenderCollectionEnumerator.Current">
- <summary>
- Gets the current element in the collection.
- </summary>
- </member>
- <member name="T:log4net.Appender.AppenderCollection.Tag">
- <summary>
- Type visible only to our subclasses
- Used to access protected constructor
- </summary>
- <exclude/>
- </member>
- <member name="F:log4net.Appender.AppenderCollection.Tag.Default">
- <summary>
- A value
- </summary>
- </member>
- <member name="T:log4net.Appender.AppenderCollection.Enumerator">
- <summary>
- Supports simple iteration over a <see cref="T:log4net.Appender.AppenderCollection"/>.
- </summary>
- <exclude/>
- </member>
- <member name="M:log4net.Appender.AppenderCollection.Enumerator.#ctor(log4net.Appender.AppenderCollection)">
- <summary>
- Initializes a new instance of the <c>Enumerator</c> class.
- </summary>
- <param name="tc"></param>
- </member>
- <member name="M:log4net.Appender.AppenderCollection.Enumerator.MoveNext">
- <summary>
- Advances the enumerator to the next element in the collection.
- </summary>
- <returns>
- <c>true</c> if the enumerator was successfully advanced to the next element;
- <c>false</c> if the enumerator has passed the end of the collection.
- </returns>
- <exception cref="T:System.InvalidOperationException">
- The collection was modified after the enumerator was created.
- </exception>
- </member>
- <member name="M:log4net.Appender.AppenderCollection.Enumerator.Reset">
- <summary>
- Sets the enumerator to its initial position, before the first element in the collection.
- </summary>
- </member>
- <member name="P:log4net.Appender.AppenderCollection.Enumerator.Current">
- <summary>
- Gets the current element in the collection.
- </summary>
- </member>
- <member name="T:log4net.Appender.AppenderCollection.ReadOnlyAppenderCollection">
- <exclude/>
- </member>
- <member name="T:log4net.Appender.AspNetTraceAppender">
- <summary>
- <para>
- Appends log events to the ASP.NET <see cref="T:System.Web.TraceContext"/> system.
- </para>
- </summary>
- <remarks>
- <para>
- Diagnostic information and tracing messages that you specify are appended to the output
- of the page that is sent to the requesting browser. Optionally, you can view this information
- from a separate trace viewer (Trace.axd) that displays trace information for every page in a
- given application.
- </para>
- <para>
- Trace statements are processed and displayed only when tracing is enabled. You can control
- whether tracing is displayed to a page, to the trace viewer, or both.
- </para>
- <para>
- The logging event is passed to the <see cref="M:TraceContext.Write(string)"/> or
- <see cref="M:TraceContext.Warn(string)"/> method depending on the level of the logging event.
- The event's logger name is the default value for the category parameter of the Write/Warn method.
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- <author>Gert Driesen</author>
- <author>Ron Grabowski</author>
- </member>
- <member name="M:log4net.Appender.AspNetTraceAppender.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:log4net.Appender.AspNetTraceAppender"/> class.
- </summary>
- <remarks>
- <para>
- Default constructor.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.AspNetTraceAppender.Append(log4net.Core.LoggingEvent)">
- <summary>
- Write the logging event to the ASP.NET trace
- </summary>
- <param name="loggingEvent">the event to log</param>
- <remarks>
- <para>
- Write the logging event to the ASP.NET trace
- <c>HttpContext.Current.Trace</c>
- (<see cref="T:System.Web.TraceContext"/>).
- </para>
- </remarks>
- </member>
- <member name="F:log4net.Appender.AspNetTraceAppender.m_category">
- <summary>
- Defaults to %logger
- </summary>
- </member>
- <member name="P:log4net.Appender.AspNetTraceAppender.RequiresLayout">
- <summary>
- This appender requires a <see cref="N:log4net.Layout"/> to be set.
- </summary>
- <value><c>true</c></value>
- <remarks>
- <para>
- This appender requires a <see cref="N:log4net.Layout"/> to be set.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Appender.AspNetTraceAppender.Category">
- <summary>
- The category parameter sent to the Trace method.
- </summary>
- <remarks>
- <para>
- Defaults to %logger which will use the logger name of the current
- <see cref="T:log4net.Core.LoggingEvent"/> as the category parameter.
- </para>
- <para>
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Appender.BufferingForwardingAppender">
- <summary>
- Buffers events and then forwards them to attached appenders.
- </summary>
- <remarks>
- <para>
- The events are buffered in this appender until conditions are
- met to allow the appender to deliver the events to the attached
- appenders. See <see cref="T:log4net.Appender.BufferingAppenderSkeleton"/> for the
- conditions that cause the buffer to be sent.
- </para>
- <para>The forwarding appender can be used to specify different
- thresholds and filters for the same appender at different locations
- within the hierarchy.
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- <author>Gert Driesen</author>
- </member>
- <member name="T:log4net.Core.IAppenderAttachable">
- <summary>
- Interface for attaching appenders to objects.
- </summary>
- <remarks>
- <para>
- Interface for attaching, removing and retrieving appenders.
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- <author>Gert Driesen</author>
- </member>
- <member name="M:log4net.Core.IAppenderAttachable.AddAppender(log4net.Appender.IAppender)">
- <summary>
- Attaches an appender.
- </summary>
- <param name="appender">The appender to add.</param>
- <remarks>
- <para>
- Add the specified appender. The implementation may
- choose to allow or deny duplicate appenders.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Core.IAppenderAttachable.GetAppender(System.String)">
- <summary>
- Gets an attached appender with the specified name.
- </summary>
- <param name="name">The name of the appender to get.</param>
- <returns>
- The appender with the name specified, or <c>null</c> if no appender with the
- specified name is found.
- </returns>
- <remarks>
- <para>
- Returns an attached appender with the <paramref name="name"/> specified.
- If no appender with the specified name is found <c>null</c> will be
- returned.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Core.IAppenderAttachable.RemoveAllAppenders">
- <summary>
- Removes all attached appenders.
- </summary>
- <remarks>
- <para>
- Removes and closes all attached appenders
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Core.IAppenderAttachable.RemoveAppender(log4net.Appender.IAppender)">
- <summary>
- Removes the specified appender from the list of attached appenders.
- </summary>
- <param name="appender">The appender to remove.</param>
- <returns>The appender removed from the list</returns>
- <remarks>
- <para>
- The appender removed is not closed.
- If you are discarding the appender you must call
- <see cref="M:log4net.Appender.IAppender.Close"/> on the appender removed.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Core.IAppenderAttachable.RemoveAppender(System.String)">
- <summary>
- Removes the appender with the specified name from the list of appenders.
- </summary>
- <param name="name">The name of the appender to remove.</param>
- <returns>The appender removed from the list</returns>
- <remarks>
- <para>
- The appender removed is not closed.
- If you are discarding the appender you must call
- <see cref="M:log4net.Appender.IAppender.Close"/> on the appender removed.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Core.IAppenderAttachable.Appenders">
- <summary>
- Gets all attached appenders.
- </summary>
- <value>
- A collection of attached appenders.
- </value>
- <remarks>
- <para>
- Gets a collection of attached appenders.
- If there are no attached appenders the
- implementation should return an empty
- collection rather than <c>null</c>.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.BufferingForwardingAppender.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:log4net.Appender.BufferingForwardingAppender"/> class.
- </summary>
- <remarks>
- <para>
- Default constructor.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.BufferingForwardingAppender.OnClose">
- <summary>
- Closes the appender and releases resources.
- </summary>
- <remarks>
- <para>
- Releases any resources allocated within the appender such as file handles,
- network connections, etc.
- </para>
- <para>
- It is a programming error to append to a closed appender.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.BufferingForwardingAppender.SendBuffer(log4net.Core.LoggingEvent[])">
- <summary>
- Send the events.
- </summary>
- <param name="events">The events that need to be send.</param>
- <remarks>
- <para>
- Forwards the events to the attached appenders.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.BufferingForwardingAppender.AddAppender(log4net.Appender.IAppender)">
- <summary>
- Adds an <see cref="T:log4net.Appender.IAppender"/> to the list of appenders of this
- instance.
- </summary>
- <param name="newAppender">The <see cref="T:log4net.Appender.IAppender"/> to add to this appender.</param>
- <remarks>
- <para>
- If the specified <see cref="T:log4net.Appender.IAppender"/> is already in the list of
- appenders, then it won't be added again.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.BufferingForwardingAppender.GetAppender(System.String)">
- <summary>
- Looks for the appender with the specified name.
- </summary>
- <param name="name">The name of the appender to lookup.</param>
- <returns>
- The appender with the specified name, or <c>null</c>.
- </returns>
- <remarks>
- <para>
- Get the named appender attached to this buffering appender.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.BufferingForwardingAppender.RemoveAllAppenders">
- <summary>
- Removes all previously added appenders from this appender.
- </summary>
- <remarks>
- <para>
- This is useful when re-reading configuration information.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.BufferingForwardingAppender.RemoveAppender(log4net.Appender.IAppender)">
- <summary>
- Removes the specified appender from the list of appenders.
- </summary>
- <param name="appender">The appender to remove.</param>
- <returns>The appender removed from the list</returns>
- <remarks>
- The appender removed is not closed.
- If you are discarding the appender you must call
- <see cref="M:log4net.Appender.IAppender.Close"/> on the appender removed.
- </remarks>
- </member>
- <member name="M:log4net.Appender.BufferingForwardingAppender.RemoveAppender(System.String)">
- <summary>
- Removes the appender with the specified name from the list of appenders.
- </summary>
- <param name="name">The name of the appender to remove.</param>
- <returns>The appender removed from the list</returns>
- <remarks>
- The appender removed is not closed.
- If you are discarding the appender you must call
- <see cref="M:log4net.Appender.IAppender.Close"/> on the appender removed.
- </remarks>
- </member>
- <member name="F:log4net.Appender.BufferingForwardingAppender.m_appenderAttachedImpl">
- <summary>
- Implementation of the <see cref="T:log4net.Core.IAppenderAttachable"/> interface
- </summary>
- </member>
- <member name="P:log4net.Appender.BufferingForwardingAppender.Appenders">
- <summary>
- Gets the appenders contained in this appender as an
- <see cref="T:System.Collections.ICollection"/>.
- </summary>
- <remarks>
- If no appenders can be found, then an <see cref="T:log4net.Util.EmptyCollection"/>
- is returned.
- </remarks>
- <returns>
- A collection of the appenders in this appender.
- </returns>
- </member>
- <member name="T:log4net.Appender.ColoredConsoleAppender">
- <summary>
- Appends logging events to the console.
- </summary>
- <remarks>
- <para>
- ColoredConsoleAppender appends log events to the standard output stream
- or the error output stream using a layout specified by the
- user. It also allows the color of a specific type of message to be set.
- </para>
- <para>
- By default, all output is written to the console's standard output stream.
- The <see cref="P:log4net.Appender.ColoredConsoleAppender.Target"/> property can be set to direct the output to the
- error stream.
- </para>
- <para>
- NOTE: This appender writes directly to the application's attached console
- not to the <c>System.Console.Out</c> or <c>System.Console.Error</c> <c>TextWriter</c>.
- The <c>System.Console.Out</c> and <c>System.Console.Error</c> streams can be
- programmatically redirected (for example NUnit does this to capture program output).
- This appender will ignore these redirections because it needs to use Win32
- API calls to colorize the output. To respect these redirections the <see cref="T:log4net.Appender.ConsoleAppender"/>
- must be used.
- </para>
- <para>
- When configuring the colored console appender, mapping should be
- specified to map a logging level to a color. For example:
- </para>
- <code lang="XML" escaped="true">
- <mapping>
- <level value="ERROR"/>
- <foreColor value="White"/>
- <backColor value="Red, HighIntensity"/>
- </mapping>
- <mapping>
- <level value="DEBUG"/>
- <backColor value="Green"/>
- </mapping>
- </code>
- <para>
- The Level is the standard log4net logging level and ForeColor and BackColor can be any
- combination of the following values:
- <list type="bullet">
- <item><term>Blue</term><description></description></item>
- <item><term>Green</term><description></description></item>
- <item><term>Red</term><description></description></item>
- <item><term>White</term><description></description></item>
- <item><term>Yellow</term><description></description></item>
- <item><term>Purple</term><description></description></item>
- <item><term>Cyan</term><description></description></item>
- <item><term>HighIntensity</term><description></description></item>
- </list>
- </para>
- </remarks>
- <author>Rick Hobbs</author>
- <author>Nicko Cadell</author>
- </member>
- <member name="F:log4net.Appender.ColoredConsoleAppender.ConsoleOut">
- <summary>
- The <see cref="P:log4net.Appender.ColoredConsoleAppender.Target"/> to use when writing to the Console
- standard output stream.
- </summary>
- <remarks>
- <para>
- The <see cref="P:log4net.Appender.ColoredConsoleAppender.Target"/> to use when writing to the Console
- standard output stream.
- </para>
- </remarks>
- </member>
- <member name="F:log4net.Appender.ColoredConsoleAppender.ConsoleError">
- <summary>
- The <see cref="P:log4net.Appender.ColoredConsoleAppender.Target"/> to use when writing to the Console
- standard error output stream.
- </summary>
- <remarks>
- <para>
- The <see cref="P:log4net.Appender.ColoredConsoleAppender.Target"/> to use when writing to the Console
- standard error output stream.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.ColoredConsoleAppender.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:log4net.Appender.ColoredConsoleAppender"/> class.
- </summary>
- <remarks>
- The instance of the <see cref="T:log4net.Appender.ColoredConsoleAppender"/> class is set up to write
- to the standard output stream.
- </remarks>
- </member>
- <member name="M:log4net.Appender.ColoredConsoleAppender.#ctor(log4net.Layout.ILayout)">
- <summary>
- Initializes a new instance of the <see cref="T:log4net.Appender.ColoredConsoleAppender"/> class
- with the specified layout.
- </summary>
- <param name="layout">the layout to use for this appender</param>
- <remarks>
- The instance of the <see cref="T:log4net.Appender.ColoredConsoleAppender"/> class is set up to write
- to the standard output stream.
- </remarks>
- </member>
- <member name="M:log4net.Appender.ColoredConsoleAppender.#ctor(log4net.Layout.ILayout,System.Boolean)">
- <summary>
- Initializes a new instance of the <see cref="T:log4net.Appender.ColoredConsoleAppender"/> class
- with the specified layout.
- </summary>
- <param name="layout">the layout to use for this appender</param>
- <param name="writeToErrorStream">flag set to <c>true</c> to write to the console error stream</param>
- <remarks>
- When <paramref name="writeToErrorStream"/> is set to <c>true</c>, output is written to
- the standard error output stream. Otherwise, output is written to the standard
- output stream.
- </remarks>
- </member>
- <member name="M:log4net.Appender.ColoredConsoleAppender.AddMapping(log4net.Appender.ColoredConsoleAppender.LevelColors)">
- <summary>
- Add a mapping of level to color - done by the config file
- </summary>
- <param name="mapping">The mapping to add</param>
- <remarks>
- <para>
- Add a <see cref="T:log4net.Appender.ColoredConsoleAppender.LevelColors"/> mapping to this appender.
- Each mapping defines the foreground and background colors
- for a level.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.ColoredConsoleAppender.Append(log4net.Core.LoggingEvent)">
- <summary>
- This method is called by the <see cref="M:AppenderSkeleton.DoAppend(log4net.Core.LoggingEvent)"/> method.
- </summary>
- <param name="loggingEvent">The event to log.</param>
- <remarks>
- <para>
- Writes the event to the console.
- </para>
- <para>
- The format of the output will depend on the appender's layout.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.ColoredConsoleAppender.ActivateOptions">
- <summary>
- Initialize the options for this appender
- </summary>
- <remarks>
- <para>
- Initialize the level to color mappings set on this appender.
- </para>
- </remarks>
- </member>
- <member name="F:log4net.Appender.ColoredConsoleAppender.m_writeToErrorStream">
- <summary>
- Flag to write output to the error stream rather than the standard output stream
- </summary>
- </member>
- <member name="F:log4net.Appender.ColoredConsoleAppender.m_levelMapping">
- <summary>
- Mapping from level object to color value
- </summary>
- </member>
- <member name="F:log4net.Appender.ColoredConsoleAppender.m_consoleOutputWriter">
- <summary>
- The console output stream writer to write to
- </summary>
- <remarks>
- <para>
- This writer is not thread safe.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Appender.ColoredConsoleAppender.Target">
- <summary>
- Target is the value of the console output stream.
- This is either <c>"Console.Out"</c> or <c>"Console.Error"</c>.
- </summary>
- <value>
- Target is the value of the console output stream.
- This is either <c>"Console.Out"</c> or <c>"Console.Error"</c>.
- </value>
- <remarks>
- <para>
- Target is the value of the console output stream.
- This is either <c>"Console.Out"</c> or <c>"Console.Error"</c>.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Appender.ColoredConsoleAppender.RequiresLayout">
- <summary>
- This appender requires a <see cref="N:log4net.Layout"/> to be set.
- </summary>
- <value><c>true</c></value>
- <remarks>
- <para>
- This appender requires a <see cref="N:log4net.Layout"/> to be set.
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Appender.ColoredConsoleAppender.Colors">
- <summary>
- The enum of possible color values for use with the color mapping method
- </summary>
- <remarks>
- <para>
- The following flags can be combined together to
- form the colors.
- </para>
- </remarks>
- <seealso cref="T:log4net.Appender.ColoredConsoleAppender"/>
- </member>
- <member name="F:log4net.Appender.ColoredConsoleAppender.Colors.Blue">
- <summary>
- color is blue
- </summary>
- </member>
- <member name="F:log4net.Appender.ColoredConsoleAppender.Colors.Green">
- <summary>
- color is green
- </summary>
- </member>
- <member name="F:log4net.Appender.ColoredConsoleAppender.Colors.Red">
- <summary>
- color is red
- </summary>
- </member>
- <member name="F:log4net.Appender.ColoredConsoleAppender.Colors.White">
- <summary>
- color is white
- </summary>
- </member>
- <member name="F:log4net.Appender.ColoredConsoleAppender.Colors.Yellow">
- <summary>
- color is yellow
- </summary>
- </member>
- <member name="F:log4net.Appender.ColoredConsoleAppender.Colors.Purple">
- <summary>
- color is purple
- </summary>
- </member>
- <member name="F:log4net.Appender.ColoredConsoleAppender.Colors.Cyan">
- <summary>
- color is cyan
- </summary>
- </member>
- <member name="F:log4net.Appender.ColoredConsoleAppender.Colors.HighIntensity">
- <summary>
- color is intensified
- </summary>
- </member>
- <member name="T:log4net.Appender.ColoredConsoleAppender.LevelColors">
- <summary>
- A class to act as a mapping between the level that a logging call is made at and
- the color it should be displayed as.
- </summary>
- <remarks>
- <para>
- Defines the mapping between a level and the color it should be displayed in.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.ColoredConsoleAppender.LevelColors.ActivateOptions">
- <summary>
- Initialize the options for the object
- </summary>
- <remarks>
- <para>
- Combine the <see cref="P:log4net.Appender.ColoredConsoleAppender.LevelColors.ForeColor"/> and <see cref="P:log4net.Appender.ColoredConsoleAppender.LevelColors.BackColor"/> together.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Appender.ColoredConsoleAppender.LevelColors.ForeColor">
- <summary>
- The mapped foreground color for the specified level
- </summary>
- <remarks>
- <para>
- Required property.
- The mapped foreground color for the specified level.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Appender.ColoredConsoleAppender.LevelColors.BackColor">
- <summary>
- The mapped background color for the specified level
- </summary>
- <remarks>
- <para>
- Required property.
- The mapped background color for the specified level.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Appender.ColoredConsoleAppender.LevelColors.CombinedColor">
- <summary>
- The combined <see cref="P:log4net.Appender.ColoredConsoleAppender.LevelColors.ForeColor"/> and <see cref="P:log4net.Appender.ColoredConsoleAppender.LevelColors.BackColor"/> suitable for
- setting the console color.
- </summary>
- </member>
- <member name="T:log4net.Appender.ConsoleAppender">
- <summary>
- Appends logging events to the console.
- </summary>
- <remarks>
- <para>
- ConsoleAppender appends log events to the standard output stream
- or the error output stream using a layout specified by the
- user.
- </para>
- <para>
- By default, all output is written to the console's standard output stream.
- The <see cref="P:log4net.Appender.ConsoleAppender.Target"/> property can be set to direct the output to the
- error stream.
- </para>
- <para>
- NOTE: This appender writes each message to the <c>System.Console.Out</c> or
- <c>System.Console.Error</c> that is set at the time the event is appended.
- Therefore it is possible to programmatically redirect the output of this appender
- (for example NUnit does this to capture program output). While this is the desired
- behavior of this appender it may have security implications in your application.
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- <author>Gert Driesen</author>
- </member>
- <member name="F:log4net.Appender.ConsoleAppender.ConsoleOut">
- <summary>
- The <see cref="P:log4net.Appender.ConsoleAppender.Target"/> to use when writing to the Console
- standard output stream.
- </summary>
- <remarks>
- <para>
- The <see cref="P:log4net.Appender.ConsoleAppender.Target"/> to use when writing to the Console
- standard output stream.
- </para>
- </remarks>
- </member>
- <member name="F:log4net.Appender.ConsoleAppender.ConsoleError">
- <summary>
- The <see cref="P:log4net.Appender.ConsoleAppender.Target"/> to use when writing to the Console
- standard error output stream.
- </summary>
- <remarks>
- <para>
- The <see cref="P:log4net.Appender.ConsoleAppender.Target"/> to use when writing to the Console
- standard error output stream.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.ConsoleAppender.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:log4net.Appender.ConsoleAppender"/> class.
- </summary>
- <remarks>
- The instance of the <see cref="T:log4net.Appender.ConsoleAppender"/> class is set up to write
- to the standard output stream.
- </remarks>
- </member>
- <member name="M:log4net.Appender.ConsoleAppender.#ctor(log4net.Layout.ILayout)">
- <summary>
- Initializes a new instance of the <see cref="T:log4net.Appender.ConsoleAppender"/> class
- with the specified layout.
- </summary>
- <param name="layout">the layout to use for this appender</param>
- <remarks>
- The instance of the <see cref="T:log4net.Appender.ConsoleAppender"/> class is set up to write
- to the standard output stream.
- </remarks>
- </member>
- <member name="M:log4net.Appender.ConsoleAppender.#ctor(log4net.Layout.ILayout,System.Boolean)">
- <summary>
- Initializes a new instance of the <see cref="T:log4net.Appender.ConsoleAppender"/> class
- with the specified layout.
- </summary>
- <param name="layout">the layout to use for this appender</param>
- <param name="writeToErrorStream">flag set to <c>true</c> to write to the console error stream</param>
- <remarks>
- When <paramref name="writeToErrorStream"/> is set to <c>true</c>, output is written to
- the standard error output stream. Otherwise, output is written to the standard
- output stream.
- </remarks>
- </member>
- <member name="M:log4net.Appender.ConsoleAppender.Append(log4net.Core.LoggingEvent)">
- <summary>
- This method is called by the <see cref="M:AppenderSkeleton.DoAppend(LoggingEvent)"/> method.
- </summary>
- <param name="loggingEvent">The event to log.</param>
- <remarks>
- <para>
- Writes the event to the console.
- </para>
- <para>
- The format of the output will depend on the appender's layout.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Appender.ConsoleAppender.Target">
- <summary>
- Target is the value of the console output stream.
- This is either <c>"Console.Out"</c> or <c>"Console.Error"</c>.
- </summary>
- <value>
- Target is the value of the console output stream.
- This is either <c>"Console.Out"</c> or <c>"Console.Error"</c>.
- </value>
- <remarks>
- <para>
- Target is the value of the console output stream.
- This is either <c>"Console.Out"</c> or <c>"Console.Error"</c>.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Appender.ConsoleAppender.RequiresLayout">
- <summary>
- This appender requires a <see cref="N:log4net.Layout"/> to be set.
- </summary>
- <value><c>true</c></value>
- <remarks>
- <para>
- This appender requires a <see cref="N:log4net.Layout"/> to be set.
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Appender.DebugAppender">
- <summary>
- Appends log events to the <see cref="T:System.Diagnostics.Debug"/> system.
- </summary>
- <remarks>
- <para>
- The application configuration file can be used to control what listeners
- are actually used. See the MSDN documentation for the
- <see cref="T:System.Diagnostics.Debug"/> class for details on configuring the
- debug system.
- </para>
- <para>
- Events are written using the <see cref="M:System.Diagnostics.Debug.Write(string,string)"/>
- method. The event's logger name is passed as the value for the category name to the Write method.
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- </member>
- <member name="M:log4net.Appender.DebugAppender.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:log4net.Appender.DebugAppender"/>.
- </summary>
- <remarks>
- <para>
- Default constructor.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.DebugAppender.#ctor(log4net.Layout.ILayout)">
- <summary>
- Initializes a new instance of the <see cref="T:log4net.Appender.DebugAppender"/>
- with a specified layout.
- </summary>
- <param name="layout">The layout to use with this appender.</param>
- <remarks>
- <para>
- Obsolete constructor.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.DebugAppender.Append(log4net.Core.LoggingEvent)">
- <summary>
- Writes the logging event to the <see cref="T:System.Diagnostics.Debug"/> system.
- </summary>
- <param name="loggingEvent">The event to log.</param>
- <remarks>
- <para>
- Writes the logging event to the <see cref="T:System.Diagnostics.Debug"/> system.
- If <see cref="P:log4net.Appender.DebugAppender.ImmediateFlush"/> is <c>true</c> then the <see cref="M:System.Diagnostics.Debug.Flush"/>
- is called.
- </para>
- </remarks>
- </member>
- <member name="F:log4net.Appender.DebugAppender.m_immediateFlush">
- <summary>
- Immediate flush means that the underlying writer or output stream
- will be flushed at the end of each append operation.
- </summary>
- <remarks>
- <para>
- Immediate flush is slower but ensures that each append request is
- actually written. If <see cref="P:log4net.Appender.DebugAppender.ImmediateFlush"/> is set to
- <c>false</c>, then there is a good chance that the last few
- logs events are not actually written to persistent media if and
- when the application crashes.
- </para>
- <para>
- The default value is <c>true</c>.</para>
- </remarks>
- </member>
- <member name="P:log4net.Appender.DebugAppender.ImmediateFlush">
- <summary>
- Gets or sets a value that indicates whether the appender will
- flush at the end of each write.
- </summary>
- <remarks>
- <para>The default behavior is to flush at the end of each
- write. If the option is set to<c>false</c>, then the underlying
- stream can defer writing to physical medium to a later time.
- </para>
- <para>
- Avoiding the flush operation at the end of each append results
- in a performance gain of 10 to 20 percent. However, there is safety
- trade-off involved in skipping flushing. Indeed, when flushing is
- skipped, then it is likely that the last few log events will not
- be recorded on disk when the application exits. This is a high
- price to pay even for a 20% performance gain.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Appender.DebugAppender.RequiresLayout">
- <summary>
- This appender requires a <see cref="N:log4net.Layout"/> to be set.
- </summary>
- <value><c>true</c></value>
- <remarks>
- <para>
- This appender requires a <see cref="N:log4net.Layout"/> to be set.
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Appender.EventLogAppender">
- <summary>
- Writes events to the system event log.
- </summary>
- <remarks>
- <para>
- The appender will fail if you try to write using an event source that doesn't exist unless it is running with local administrator privileges.
- See also http://logging.apache.org/log4net/release/faq.html#trouble-EventLog
- </para>
- <para>
- The <c>EventID</c> of the event log entry can be
- set using the <c>EventID</c> property (<see cref="P:log4net.Core.LoggingEvent.Properties"/>)
- on the <see cref="T:log4net.Core.LoggingEvent"/>.
- </para>
- <para>
- The <c>Category</c> of the event log entry can be
- set using the <c>Category</c> property (<see cref="P:log4net.Core.LoggingEvent.Properties"/>)
- on the <see cref="T:log4net.Core.LoggingEvent"/>.
- </para>
- <para>
- There is a limit of 32K characters for an event log message
- </para>
- <para>
- When configuring the EventLogAppender a mapping can be
- specified to map a logging level to an event log entry type. For example:
- </para>
- <code lang="XML">
- <mapping>
- <level value="ERROR" />
- <eventLogEntryType value="Error" />
- </mapping>
- <mapping>
- <level value="DEBUG" />
- <eventLogEntryType value="Information" />
- </mapping>
- </code>
- <para>
- The Level is the standard log4net logging level and eventLogEntryType can be any value
- from the <see cref="T:System.Diagnostics.EventLogEntryType"/> enum, i.e.:
- <list type="bullet">
- <item><term>Error</term><description>an error event</description></item>
- <item><term>Warning</term><description>a warning event</description></item>
- <item><term>Information</term><description>an informational event</description></item>
- </list>
- </para>
- </remarks>
- <author>Aspi Havewala</author>
- <author>Douglas de la Torre</author>
- <author>Nicko Cadell</author>
- <author>Gert Driesen</author>
- <author>Thomas Voss</author>
- </member>
- <member name="M:log4net.Appender.EventLogAppender.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:log4net.Appender.EventLogAppender"/> class.
- </summary>
- <remarks>
- <para>
- Default constructor.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.EventLogAppender.#ctor(log4net.Layout.ILayout)">
- <summary>
- Initializes a new instance of the <see cref="T:log4net.Appender.EventLogAppender"/> class
- with the specified <see cref="T:log4net.Layout.ILayout"/>.
- </summary>
- <param name="layout">The <see cref="T:log4net.Layout.ILayout"/> to use with this appender.</param>
- <remarks>
- <para>
- Obsolete constructor.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.EventLogAppender.AddMapping(log4net.Appender.EventLogAppender.Level2EventLogEntryType)">
- <summary>
- Add a mapping of level to <see cref="T:System.Diagnostics.EventLogEntryType"/> - done by the config file
- </summary>
- <param name="mapping">The mapping to add</param>
- <remarks>
- <para>
- Add a <see cref="T:log4net.Appender.EventLogAppender.Level2EventLogEntryType"/> mapping to this appender.
- Each mapping defines the event log entry type for a level.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.EventLogAppender.ActivateOptions">
- <summary>
- Initialize the appender based on the options set
- </summary>
- <remarks>
- <para>
- This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
- activation scheme. The <see cref="M:log4net.Appender.EventLogAppender.ActivateOptions"/> method must
- be called on this object after the configuration properties have
- been set. Until <see cref="M:log4net.Appender.EventLogAppender.ActivateOptions"/> is called this
- object is in an undefined state and must not be used.
- </para>
- <para>
- If any of the configuration properties are modified then
- <see cref="M:log4net.Appender.EventLogAppender.ActivateOptions"/> must be called again.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.EventLogAppender.CreateEventSource(System.String,System.String,System.String)">
- <summary>
- Create an event log source
- </summary>
- <remarks>
- Uses different API calls under NET_2_0
- </remarks>
- </member>
- <member name="M:log4net.Appender.EventLogAppender.Append(log4net.Core.LoggingEvent)">
- <summary>
- This method is called by the <see cref="M:AppenderSkeleton.DoAppend(LoggingEvent)"/>
- method.
- </summary>
- <param name="loggingEvent">the event to log</param>
- <remarks>
- <para>Writes the event to the system event log using the
- <see cref="P:log4net.Appender.EventLogAppender.ApplicationName"/>.</para>
-
- <para>If the event has an <c>EventID</c> property (see <see cref="P:log4net.Core.LoggingEvent.Properties"/>)
- set then this integer will be used as the event log event id.</para>
-
- <para>
- There is a limit of 32K characters for an event log message
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.EventLogAppender.GetEntryType(log4net.Core.Level)">
- <summary>
- Get the equivalent <see cref="T:System.Diagnostics.EventLogEntryType"/> for a <see cref="T:log4net.Core.Level"/> <paramref name="level"/>
- </summary>
- <param name="level">the Level to convert to an EventLogEntryType</param>
- <returns>The equivalent <see cref="T:System.Diagnostics.EventLogEntryType"/> for a <see cref="T:log4net.Core.Level"/> <paramref name="level"/></returns>
- <remarks>
- Because there are fewer applicable <see cref="T:System.Diagnostics.EventLogEntryType"/>
- values to use in logging levels than there are in the
- <see cref="T:log4net.Core.Level"/> this is a one way mapping. There is
- a loss of information during the conversion.
- </remarks>
- </member>
- <member name="F:log4net.Appender.EventLogAppender.m_logName">
- <summary>
- The log name is the section in the event logs where the messages
- are stored.
- </summary>
- </member>
- <member name="F:log4net.Appender.EventLogAppender.m_applicationName">
- <summary>
- Name of the application to use when logging. This appears in the
- application column of the event log named by <see cref="F:log4net.Appender.EventLogAppender.m_logName"/>.
- </summary>
- </member>
- <member name="F:log4net.Appender.EventLogAppender.m_machineName">
- <summary>
- The name of the machine which holds the event log. This is
- currently only allowed to be '.' i.e. the current machine.
- </summary>
- </member>
- <member name="F:log4net.Appender.EventLogAppender.m_levelMapping">
- <summary>
- Mapping from level object to EventLogEntryType
- </summary>
- </member>
- <member name="F:log4net.Appender.EventLogAppender.m_securityContext">
- <summary>
- The security context to use for privileged calls
- </summary>
- </member>
- <member name="F:log4net.Appender.EventLogAppender.m_eventId">
- <summary>
- The event ID to use unless one is explicitly specified via the <c>LoggingEvent</c>'s properties.
- </summary>
- </member>
- <member name="F:log4net.Appender.EventLogAppender.m_category">
- <summary>
- The event category to use unless one is explicitly specified via the <c>LoggingEvent</c>'s properties.
- </summary>
- </member>
- <member name="F:log4net.Appender.EventLogAppender.declaringType">
- <summary>
- The fully qualified type of the EventLogAppender class.
- </summary>
- <remarks>
- Used by the internal logger to record the Type of the
- log message.
- </remarks>
- </member>
- <member name="F:log4net.Appender.EventLogAppender.MAX_EVENTLOG_MESSAGE_SIZE_DEFAULT">
- <summary>
- The maximum size supported by default.
- </summary>
- <remarks>
- http://msdn.microsoft.com/en-us/library/xzwc042w(v=vs.100).aspx
- The 32766 documented max size is two bytes shy of 32K (I'm assuming 32766
- may leave space for a two byte null terminator of #0#0). The 32766 max
- length is what the .NET 4.0 source code checks for, but this is WRONG!
- Strings with a length > 31839 on Windows Vista or higher can CORRUPT
- the event log! See: System.Diagnostics.EventLogInternal.InternalWriteEvent()
- for the use of the 32766 max size.
- </remarks>
- </member>
- <member name="F:log4net.Appender.EventLogAppender.MAX_EVENTLOG_MESSAGE_SIZE_VISTA_OR_NEWER">
- <summary>
- The maximum size supported by a windows operating system that is vista
- or newer.
- </summary>
- <remarks>
- See ReportEvent API:
- http://msdn.microsoft.com/en-us/library/aa363679(VS.85).aspx
- ReportEvent's lpStrings parameter:
- "A pointer to a buffer containing an array of
- null-terminated strings that are merged into the message before Event Viewer
- displays the string to the user. This parameter must be a valid pointer
- (or NULL), even if wNumStrings is zero. Each string is limited to 31,839 characters."
-
- Going beyond the size of 31839 will (at some point) corrupt the event log on Windows
- Vista or higher! It may succeed for a while...but you will eventually run into the
- error: "System.ComponentModel.Win32Exception : A device attached to the system is
- not functioning", and the event log will then be corrupt (I was able to corrupt
- an event log using a length of 31877 on Windows 7).
-
- The max size for Windows Vista or higher is documented here:
- http://msdn.microsoft.com/en-us/library/xzwc042w(v=vs.100).aspx.
- Going over this size may succeed a few times but the buffer will overrun and
- eventually corrupt the log (based on testing).
-
- The maxEventMsgSize size is based on the max buffer size of the lpStrings parameter of the ReportEvent API.
- The documented max size for EventLog.WriteEntry for Windows Vista and higher is 31839, but I'm leaving room for a
- terminator of #0#0, as we cannot see the source of ReportEvent (though we could use an API monitor to examine the
- buffer, given enough time).
- </remarks>
- </member>
- <member name="F:log4net.Appender.EventLogAppender.MAX_EVENTLOG_MESSAGE_SIZE">
- <summary>
- The maximum size that the operating system supports for
- a event log message.
- </summary>
- <remarks>
- Used to determine the maximum string length that can be written
- to the operating system event log and eventually truncate a string
- that exceeds the limits.
- </remarks>
- </member>
- <member name="M:log4net.Appender.EventLogAppender.GetMaxEventLogMessageSize">
- <summary>
- This method determines the maximum event log message size allowed for
- the current environment.
- </summary>
- <returns></returns>
- </member>
- <member name="P:log4net.Appender.EventLogAppender.LogName">
- <summary>
- The name of the log where messages will be stored.
- </summary>
- <value>
- The string name of the log where messages will be stored.
- </value>
- <remarks>
- <para>This is the name of the log as it appears in the Event Viewer
- tree. The default value is to log into the <c>Application</c>
- log, this is where most applications write their events. However
- if you need a separate log for your application (or applications)
- then you should set the <see cref="P:log4net.Appender.EventLogAppender.LogName"/> appropriately.</para>
- <para>This should not be used to distinguish your event log messages
- from those of other applications, the <see cref="P:log4net.Appender.EventLogAppender.ApplicationName"/>
- property should be used to distinguish events. This property should be
- used to group together events into a single log.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Appender.EventLogAppender.ApplicationName">
- <summary>
- Property used to set the Application name. This appears in the
- event logs when logging.
- </summary>
- <value>
- The string used to distinguish events from different sources.
- </value>
- <remarks>
- Sets the event log source property.
- </remarks>
- </member>
- <member name="P:log4net.Appender.EventLogAppender.MachineName">
- <summary>
- This property is used to return the name of the computer to use
- when accessing the event logs. Currently, this is the current
- computer, denoted by a dot "."
- </summary>
- <value>
- The string name of the machine holding the event log that
- will be logged into.
- </value>
- <remarks>
- This property cannot be changed. It is currently set to '.'
- i.e. the local machine. This may be changed in future.
- </remarks>
- </member>
- <member name="P:log4net.Appender.EventLogAppender.SecurityContext">
- <summary>
- Gets or sets the <see cref="P:log4net.Appender.EventLogAppender.SecurityContext"/> used to write to the EventLog.
- </summary>
- <value>
- The <see cref="P:log4net.Appender.EventLogAppender.SecurityContext"/> used to write to the EventLog.
- </value>
- <remarks>
- <para>
- The system security context used to write to the EventLog.
- </para>
- <para>
- Unless a <see cref="P:log4net.Appender.EventLogAppender.SecurityContext"/> specified here for this appender
- the <see cref="P:log4net.Core.SecurityContextProvider.DefaultProvider"/> is queried for the
- security context to use. The default behavior is to use the security context
- of the current thread.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Appender.EventLogAppender.EventId">
- <summary>
- Gets or sets the <c>EventId</c> to use unless one is explicitly specified via the <c>LoggingEvent</c>'s properties.
- </summary>
- <remarks>
- <para>
- The <c>EventID</c> of the event log entry will normally be
- set using the <c>EventID</c> property (<see cref="P:log4net.Core.LoggingEvent.Properties"/>)
- on the <see cref="T:log4net.Core.LoggingEvent"/>.
- This property provides the fallback value which defaults to 0.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Appender.EventLogAppender.Category">
- <summary>
- Gets or sets the <c>Category</c> to use unless one is explicitly specified via the <c>LoggingEvent</c>'s properties.
- </summary>
- <remarks>
- <para>
- The <c>Category</c> of the event log entry will normally be
- set using the <c>Category</c> property (<see cref="P:log4net.Core.LoggingEvent.Properties"/>)
- on the <see cref="T:log4net.Core.LoggingEvent"/>.
- This property provides the fallback value which defaults to 0.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Appender.EventLogAppender.RequiresLayout">
- <summary>
- This appender requires a <see cref="N:log4net.Layout"/> to be set.
- </summary>
- <value><c>true</c></value>
- <remarks>
- <para>
- This appender requires a <see cref="N:log4net.Layout"/> to be set.
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Appender.EventLogAppender.Level2EventLogEntryType">
- <summary>
- A class to act as a mapping between the level that a logging call is made at and
- the color it should be displayed as.
- </summary>
- <remarks>
- <para>
- Defines the mapping between a level and its event log entry type.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Appender.EventLogAppender.Level2EventLogEntryType.EventLogEntryType">
- <summary>
- The <see cref="P:log4net.Appender.EventLogAppender.Level2EventLogEntryType.EventLogEntryType"/> for this entry
- </summary>
- <remarks>
- <para>
- Required property.
- The <see cref="P:log4net.Appender.EventLogAppender.Level2EventLogEntryType.EventLogEntryType"/> for this entry
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Appender.FileAppender">
- <summary>
- Appends logging events to a file.
- </summary>
- <remarks>
- <para>
- Logging events are sent to the file specified by
- the <see cref="P:log4net.Appender.FileAppender.File"/> property.
- </para>
- <para>
- The file can be opened in either append or overwrite mode
- by specifying the <see cref="P:log4net.Appender.FileAppender.AppendToFile"/> property.
- If the file path is relative it is taken as relative from
- the application base directory. The file encoding can be
- specified by setting the <see cref="P:log4net.Appender.FileAppender.Encoding"/> property.
- </para>
- <para>
- The layout's <see cref="P:log4net.Layout.ILayout.Header"/> and <see cref="P:log4net.Layout.ILayout.Footer"/>
- values will be written each time the file is opened and closed
- respectively. If the <see cref="P:log4net.Appender.FileAppender.AppendToFile"/> property is <see langword="true"/>
- then the file may contain multiple copies of the header and footer.
- </para>
- <para>
- This appender will first try to open the file for writing when <see cref="M:log4net.Appender.FileAppender.ActivateOptions"/>
- is called. This will typically be during configuration.
- If the file cannot be opened for writing the appender will attempt
- to open the file again each time a message is logged to the appender.
- If the file cannot be opened for writing when a message is logged then
- the message will be discarded by this appender.
- </para>
- <para>
- The <see cref="T:log4net.Appender.FileAppender"/> supports pluggable file locking models via
- the <see cref="P:log4net.Appender.FileAppender.LockingModel"/> property.
- The default behavior, implemented by <see cref="T:log4net.Appender.FileAppender.ExclusiveLock"/>
- is to obtain an exclusive write lock on the file until this appender is closed.
- The alternative models only hold a
- write lock while the appender is writing a logging event (<see cref="T:log4net.Appender.FileAppender.MinimalLock"/>)
- or synchronize by using a named system wide Mutex (<see cref="T:log4net.Appender.FileAppender.InterProcessLock"/>).
- </para>
- <para>
- All locking strategies have issues and you should seriously consider using a different strategy that
- avoids having multiple processes logging to the same file.
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- <author>Gert Driesen</author>
- <author>Rodrigo B. de Oliveira</author>
- <author>Douglas de la Torre</author>
- <author>Niall Daley</author>
- </member>
- <member name="T:log4net.Appender.TextWriterAppender">
- <summary>
- Sends logging events to a <see cref="T:System.IO.TextWriter"/>.
- </summary>
- <remarks>
- <para>
- An Appender that writes to a <see cref="T:System.IO.TextWriter"/>.
- </para>
- <para>
- This appender may be used stand alone if initialized with an appropriate
- writer, however it is typically used as a base class for an appender that
- can open a <see cref="T:System.IO.TextWriter"/> to write to.
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- <author>Gert Driesen</author>
- <author>Douglas de la Torre</author>
- </member>
- <member name="M:log4net.Appender.TextWriterAppender.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:log4net.Appender.TextWriterAppender"/> class.
- </summary>
- <remarks>
- <para>
- Default constructor.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.TextWriterAppender.#ctor(log4net.Layout.ILayout,System.IO.Stream)">
- <summary>
- Initializes a new instance of the <see cref="T:log4net.Appender.TextWriterAppender"/> class and
- sets the output destination to a new <see cref="T:System.IO.StreamWriter"/> initialized
- with the specified <see cref="T:System.IO.Stream"/>.
- </summary>
- <param name="layout">The layout to use with this appender.</param>
- <param name="os">The <see cref="T:System.IO.Stream"/> to output to.</param>
- <remarks>
- <para>
- Obsolete constructor.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.TextWriterAppender.#ctor(log4net.Layout.ILayout,System.IO.TextWriter)">
- <summary>
- Initializes a new instance of the <see cref="T:log4net.Appender.TextWriterAppender"/> class and sets
- the output destination to the specified <see cref="T:System.IO.StreamWriter"/>.
- </summary>
- <param name="layout">The layout to use with this appender</param>
- <param name="writer">The <see cref="T:System.IO.TextWriter"/> to output to</param>
- <remarks>
- The <see cref="T:System.IO.TextWriter"/> must have been previously opened.
- </remarks>
- <remarks>
- <para>
- Obsolete constructor.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.TextWriterAppender.PreAppendCheck">
- <summary>
- This method determines if there is a sense in attempting to append.
- </summary>
- <remarks>
- <para>
- This method checks if an output target has been set and if a
- layout has been set.
- </para>
- </remarks>
- <returns><c>false</c> if any of the preconditions fail.</returns>
- </member>
- <member name="M:log4net.Appender.TextWriterAppender.Append(log4net.Core.LoggingEvent)">
- <summary>
- This method is called by the <see cref="M:AppenderSkeleton.DoAppend(LoggingEvent)"/>
- method.
- </summary>
- <param name="loggingEvent">The event to log.</param>
- <remarks>
- <para>
- Writes a log statement to the output stream if the output stream exists
- and is writable.
- </para>
- <para>
- The format of the output will depend on the appender's layout.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.TextWriterAppender.Append(log4net.Core.LoggingEvent[])">
- <summary>
- This method is called by the <see cref="M:AppenderSkeleton.DoAppend(LoggingEvent[])"/>
- method.
- </summary>
- <param name="loggingEvents">The array of events to log.</param>
- <remarks>
- <para>
- This method writes all the bulk logged events to the output writer
- before flushing the stream.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.TextWriterAppender.OnClose">
- <summary>
- Close this appender instance. The underlying stream or writer is also closed.
- </summary>
- <remarks>
- Closed appenders cannot be reused.
- </remarks>
- </member>
- <member name="M:log4net.Appender.TextWriterAppender.WriteFooterAndCloseWriter">
- <summary>
- Writes the footer and closes the underlying <see cref="T:System.IO.TextWriter"/>.
- </summary>
- <remarks>
- <para>
- Writes the footer and closes the underlying <see cref="T:System.IO.TextWriter"/>.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.TextWriterAppender.CloseWriter">
- <summary>
- Closes the underlying <see cref="T:System.IO.TextWriter"/>.
- </summary>
- <remarks>
- <para>
- Closes the underlying <see cref="T:System.IO.TextWriter"/>.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.TextWriterAppender.Reset">
- <summary>
- Clears internal references to the underlying <see cref="T:System.IO.TextWriter"/>
- and other variables.
- </summary>
- <remarks>
- <para>
- Subclasses can override this method for an alternate closing behavior.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.TextWriterAppender.WriteFooter">
- <summary>
- Writes a footer as produced by the embedded layout's <see cref="P:log4net.Layout.ILayout.Footer"/> property.
- </summary>
- <remarks>
- <para>
- Writes a footer as produced by the embedded layout's <see cref="P:log4net.Layout.ILayout.Footer"/> property.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.TextWriterAppender.WriteHeader">
- <summary>
- Writes a header produced by the embedded layout's <see cref="P:log4net.Layout.ILayout.Header"/> property.
- </summary>
- <remarks>
- <para>
- Writes a header produced by the embedded layout's <see cref="P:log4net.Layout.ILayout.Header"/> property.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.TextWriterAppender.PrepareWriter">
- <summary>
- Called to allow a subclass to lazily initialize the writer
- </summary>
- <remarks>
- <para>
- This method is called when an event is logged and the <see cref="P:log4net.Appender.TextWriterAppender.Writer"/> or
- <see cref="P:log4net.Appender.TextWriterAppender.QuietWriter"/> have not been set. This allows a subclass to
- attempt to initialize the writer multiple times.
- </para>
- </remarks>
- </member>
- <member name="F:log4net.Appender.TextWriterAppender.m_qtw">
- <summary>
- This is the <see cref="T:log4net.Util.QuietTextWriter"/> where logging events
- will be written to.
- </summary>
- </member>
- <member name="F:log4net.Appender.TextWriterAppender.m_immediateFlush">
- <summary>
- Immediate flush means that the underlying <see cref="T:System.IO.TextWriter"/>
- or output stream will be flushed at the end of each append operation.
- </summary>
- <remarks>
- <para>
- Immediate flush is slower but ensures that each append request is
- actually written. If <see cref="P:log4net.Appender.TextWriterAppender.ImmediateFlush"/> is set to
- <c>false</c>, then there is a good chance that the last few
- logging events are not actually persisted if and when the application
- crashes.
- </para>
- <para>
- The default value is <c>true</c>.
- </para>
- </remarks>
- </member>
- <member name="F:log4net.Appender.TextWriterAppender.declaringType">
- <summary>
- The fully qualified type of the TextWriterAppender class.
- </summary>
- <remarks>
- Used by the internal logger to record the Type of the
- log message.
- </remarks>
- </member>
- <member name="P:log4net.Appender.TextWriterAppender.ImmediateFlush">
- <summary>
- Gets or set whether the appender will flush at the end
- of each append operation.
- </summary>
- <value>
- <para>
- The default behavior is to flush at the end of each
- append operation.
- </para>
- <para>
- If this option is set to <c>false</c>, then the underlying
- stream can defer persisting the logging event to a later
- time.
- </para>
- </value>
- <remarks>
- Avoiding the flush operation at the end of each append results in
- a performance gain of 10 to 20 percent. However, there is safety
- trade-off involved in skipping flushing. Indeed, when flushing is
- skipped, then it is likely that the last few log events will not
- be recorded on disk when the application exits. This is a high
- price to pay even for a 20% performance gain.
- </remarks>
- </member>
- <member name="P:log4net.Appender.TextWriterAppender.Writer">
- <summary>
- Sets the <see cref="T:System.IO.TextWriter"/> where the log output will go.
- </summary>
- <remarks>
- <para>
- The specified <see cref="T:System.IO.TextWriter"/> must be open and writable.
- </para>
- <para>
- The <see cref="T:System.IO.TextWriter"/> will be closed when the appender
- instance is closed.
- </para>
- <para>
- <b>Note:</b> Logging to an unopened <see cref="T:System.IO.TextWriter"/> will fail.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Appender.TextWriterAppender.ErrorHandler">
- <summary>
- Gets or set the <see cref="T:log4net.Core.IErrorHandler"/> and the underlying
- <see cref="T:log4net.Util.QuietTextWriter"/>, if any, for this appender.
- </summary>
- <value>
- The <see cref="T:log4net.Core.IErrorHandler"/> for this appender.
- </value>
- </member>
- <member name="P:log4net.Appender.TextWriterAppender.RequiresLayout">
- <summary>
- This appender requires a <see cref="N:log4net.Layout"/> to be set.
- </summary>
- <value><c>true</c></value>
- <remarks>
- <para>
- This appender requires a <see cref="N:log4net.Layout"/> to be set.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Appender.TextWriterAppender.QuietWriter">
- <summary>
- Gets or sets the <see cref="T:log4net.Util.QuietTextWriter"/> where logging events
- will be written to.
- </summary>
- <value>
- The <see cref="T:log4net.Util.QuietTextWriter"/> where logging events are written.
- </value>
- <remarks>
- <para>
- This is the <see cref="T:log4net.Util.QuietTextWriter"/> where logging events
- will be written to.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.FileAppender.#ctor">
- <summary>
- Default constructor
- </summary>
- <remarks>
- <para>
- Default constructor
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.FileAppender.#ctor(log4net.Layout.ILayout,System.String,System.Boolean)">
- <summary>
- Construct a new appender using the layout, file and append mode.
- </summary>
- <param name="layout">the layout to use with this appender</param>
- <param name="filename">the full path to the file to write to</param>
- <param name="append">flag to indicate if the file should be appended to</param>
- <remarks>
- <para>
- Obsolete constructor.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.FileAppender.#ctor(log4net.Layout.ILayout,System.String)">
- <summary>
- Construct a new appender using the layout and file specified.
- The file will be appended to.
- </summary>
- <param name="layout">the layout to use with this appender</param>
- <param name="filename">the full path to the file to write to</param>
- <remarks>
- <para>
- Obsolete constructor.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.FileAppender.ActivateOptions">
- <summary>
- Activate the options on the file appender.
- </summary>
- <remarks>
- <para>
- This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
- activation scheme. The <see cref="M:log4net.Appender.FileAppender.ActivateOptions"/> method must
- be called on this object after the configuration properties have
- been set. Until <see cref="M:log4net.Appender.FileAppender.ActivateOptions"/> is called this
- object is in an undefined state and must not be used.
- </para>
- <para>
- If any of the configuration properties are modified then
- <see cref="M:log4net.Appender.FileAppender.ActivateOptions"/> must be called again.
- </para>
- <para>
- This will cause the file to be opened.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.FileAppender.Reset">
- <summary>
- Closes any previously opened file and calls the parent's <see cref="M:log4net.Appender.TextWriterAppender.Reset"/>.
- </summary>
- <remarks>
- <para>
- Resets the filename and the file stream.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.FileAppender.PrepareWriter">
- <summary>
- Called to initialize the file writer
- </summary>
- <remarks>
- <para>
- Will be called for each logged message until the file is
- successfully opened.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.FileAppender.Append(log4net.Core.LoggingEvent)">
- <summary>
- This method is called by the <see cref="M:AppenderSkeleton.DoAppend(LoggingEvent)"/>
- method.
- </summary>
- <param name="loggingEvent">The event to log.</param>
- <remarks>
- <para>
- Writes a log statement to the output stream if the output stream exists
- and is writable.
- </para>
- <para>
- The format of the output will depend on the appender's layout.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.FileAppender.Append(log4net.Core.LoggingEvent[])">
- <summary>
- This method is called by the <see cref="M:AppenderSkeleton.DoAppend(LoggingEvent[])"/>
- method.
- </summary>
- <param name="loggingEvents">The array of events to log.</param>
- <remarks>
- <para>
- Acquires the output file locks once before writing all the events to
- the stream.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.FileAppender.WriteFooter">
- <summary>
- Writes a footer as produced by the embedded layout's <see cref="P:log4net.Layout.ILayout.Footer"/> property.
- </summary>
- <remarks>
- <para>
- Writes a footer as produced by the embedded layout's <see cref="P:log4net.Layout.ILayout.Footer"/> property.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.FileAppender.WriteHeader">
- <summary>
- Writes a header produced by the embedded layout's <see cref="P:log4net.Layout.ILayout.Header"/> property.
- </summary>
- <remarks>
- <para>
- Writes a header produced by the embedded layout's <see cref="P:log4net.Layout.ILayout.Header"/> property.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.FileAppender.CloseWriter">
- <summary>
- Closes the underlying <see cref="T:System.IO.TextWriter"/>.
- </summary>
- <remarks>
- <para>
- Closes the underlying <see cref="T:System.IO.TextWriter"/>.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.FileAppender.CloseFile">
- <summary>
- Closes the previously opened file.
- </summary>
- <remarks>
- <para>
- Writes the <see cref="P:log4net.Layout.ILayout.Footer"/> to the file and then
- closes the file.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.FileAppender.SafeOpenFile(System.String,System.Boolean)">
- <summary>
- Sets and <i>opens</i> the file where the log output will go. The specified file must be writable.
- </summary>
- <param name="fileName">The path to the log file. Must be a fully qualified path.</param>
- <param name="append">If true will append to fileName. Otherwise will truncate fileName</param>
- <remarks>
- <para>
- Calls <see cref="M:log4net.Appender.FileAppender.OpenFile(System.String,System.Boolean)"/> but guarantees not to throw an exception.
- Errors are passed to the <see cref="P:log4net.Appender.TextWriterAppender.ErrorHandler"/>.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.FileAppender.OpenFile(System.String,System.Boolean)">
- <summary>
- Sets and <i>opens</i> the file where the log output will go. The specified file must be writable.
- </summary>
- <param name="fileName">The path to the log file. Must be a fully qualified path.</param>
- <param name="append">If true will append to fileName. Otherwise will truncate fileName</param>
- <remarks>
- <para>
- If there was already an opened file, then the previous file
- is closed first.
- </para>
- <para>
- This method will ensure that the directory structure
- for the <paramref name="fileName"/> specified exists.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.FileAppender.SetQWForFiles(System.IO.Stream)">
- <summary>
- Sets the quiet writer used for file output
- </summary>
- <param name="fileStream">the file stream that has been opened for writing</param>
- <remarks>
- <para>
- This implementation of <see cref="M:SetQWForFiles(Stream)"/> creates a <see cref="T:System.IO.StreamWriter"/>
- over the <paramref name="fileStream"/> and passes it to the
- <see cref="M:SetQWForFiles(TextWriter)"/> method.
- </para>
- <para>
- This method can be overridden by sub classes that want to wrap the
- <see cref="T:System.IO.Stream"/> in some way, for example to encrypt the output
- data using a <c>System.Security.Cryptography.CryptoStream</c>.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.FileAppender.SetQWForFiles(System.IO.TextWriter)">
- <summary>
- Sets the quiet writer being used.
- </summary>
- <param name="writer">the writer over the file stream that has been opened for writing</param>
- <remarks>
- <para>
- This method can be overridden by sub classes that want to
- wrap the <see cref="T:System.IO.TextWriter"/> in some way.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.FileAppender.ConvertToFullPath(System.String)">
- <summary>
- Convert a path into a fully qualified path.
- </summary>
- <param name="path">The path to convert.</param>
- <returns>The fully qualified path.</returns>
- <remarks>
- <para>
- Converts the path specified to a fully
- qualified path. If the path is relative it is
- taken as relative from the application base
- directory.
- </para>
- </remarks>
- </member>
- <member name="F:log4net.Appender.FileAppender.m_appendToFile">
- <summary>
- Flag to indicate if we should append to the file
- or overwrite the file. The default is to append.
- </summary>
- </member>
- <member name="F:log4net.Appender.FileAppender.m_fileName">
- <summary>
- The name of the log file.
- </summary>
- </member>
- <member name="F:log4net.Appender.FileAppender.m_encoding">
- <summary>
- The encoding to use for the file stream.
- </summary>
- </member>
- <member name="F:log4net.Appender.FileAppender.m_securityContext">
- <summary>
- The security context to use for privileged calls
- </summary>
- </member>
- <member name="F:log4net.Appender.FileAppender.m_stream">
- <summary>
- The stream to log to. Has added locking semantics
- </summary>
- </member>
- <member name="F:log4net.Appender.FileAppender.m_lockingModel">
- <summary>
- The locking model to use
- </summary>
- </member>
- <member name="F:log4net.Appender.FileAppender.declaringType">
- <summary>
- The fully qualified type of the FileAppender class.
- </summary>
- <remarks>
- Used by the internal logger to record the Type of the
- log message.
- </remarks>
- </member>
- <member name="P:log4net.Appender.FileAppender.File">
- <summary>
- Gets or sets the path to the file that logging will be written to.
- </summary>
- <value>
- The path to the file that logging will be written to.
- </value>
- <remarks>
- <para>
- If the path is relative it is taken as relative from
- the application base directory.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Appender.FileAppender.AppendToFile">
- <summary>
- Gets or sets a flag that indicates whether the file should be
- appended to or overwritten.
- </summary>
- <value>
- Indicates whether the file should be appended to or overwritten.
- </value>
- <remarks>
- <para>
- If the value is set to false then the file will be overwritten, if
- it is set to true then the file will be appended to.
- </para>
- The default value is true.
- </remarks>
- </member>
- <member name="P:log4net.Appender.FileAppender.Encoding">
- <summary>
- Gets or sets <see cref="P:log4net.Appender.FileAppender.Encoding"/> used to write to the file.
- </summary>
- <value>
- The <see cref="P:log4net.Appender.FileAppender.Encoding"/> used to write to the file.
- </value>
- <remarks>
- <para>
- The default encoding set is <see cref="P:System.Text.Encoding.Default"/>
- which is the encoding for the system's current ANSI code page.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Appender.FileAppender.SecurityContext">
- <summary>
- Gets or sets the <see cref="P:log4net.Appender.FileAppender.SecurityContext"/> used to write to the file.
- </summary>
- <value>
- The <see cref="P:log4net.Appender.FileAppender.SecurityContext"/> used to write to the file.
- </value>
- <remarks>
- <para>
- Unless a <see cref="P:log4net.Appender.FileAppender.SecurityContext"/> specified here for this appender
- the <see cref="P:log4net.Core.SecurityContextProvider.DefaultProvider"/> is queried for the
- security context to use. The default behavior is to use the security context
- of the current thread.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Appender.FileAppender.LockingModel">
- <summary>
- Gets or sets the <see cref="P:log4net.Appender.FileAppender.LockingModel"/> used to handle locking of the file.
- </summary>
- <value>
- The <see cref="P:log4net.Appender.FileAppender.LockingModel"/> used to lock the file.
- </value>
- <remarks>
- <para>
- Gets or sets the <see cref="P:log4net.Appender.FileAppender.LockingModel"/> used to handle locking of the file.
- </para>
- <para>
- There are three built in locking models, <see cref="T:log4net.Appender.FileAppender.ExclusiveLock"/>, <see cref="T:log4net.Appender.FileAppender.MinimalLock"/> and <see cref="T:log4net.Appender.FileAppender.InterProcessLock"/> .
- The first locks the file from the start of logging to the end, the
- second locks only for the minimal amount of time when logging each message
- and the last synchronizes processes using a named system wide Mutex.
- </para>
- <para>
- The default locking model is the <see cref="T:log4net.Appender.FileAppender.ExclusiveLock"/>.
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Appender.FileAppender.LockingStream">
- <summary>
- Write only <see cref="T:System.IO.Stream"/> that uses the <see cref="T:log4net.Appender.FileAppender.LockingModelBase"/>
- to manage access to an underlying resource.
- </summary>
- </member>
- <member name="M:log4net.Appender.FileAppender.LockingStream.BeginWrite(System.Byte[],System.Int32,System.Int32,System.AsyncCallback,System.Object)">
- <summary>
- True asynchronous writes are not supported, the implementation forces a synchronous write.
- </summary>
- </member>
- <member name="T:log4net.Core.LogException">
- <summary>
- Exception base type for log4net.
- </summary>
- <remarks>
- <para>
- This type extends <see cref="T:System.ApplicationException"/>. It
- does not add any new functionality but does differentiate the
- type of exception being thrown.
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- <author>Gert Driesen</author>
- </member>
- <member name="M:log4net.Core.LogException.#ctor">
- <summary>
- Constructor
- </summary>
- <remarks>
- <para>
- Initializes a new instance of the <see cref="T:log4net.Core.LogException"/> class.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Core.LogException.#ctor(System.String)">
- <summary>
- Constructor
- </summary>
- <param name="message">A message to include with the exception.</param>
- <remarks>
- <para>
- Initializes a new instance of the <see cref="T:log4net.Core.LogException"/> class with
- the specified message.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Core.LogException.#ctor(System.String,System.Exception)">
- <summary>
- Constructor
- </summary>
- <param name="message">A message to include with the exception.</param>
- <param name="innerException">A nested exception to include.</param>
- <remarks>
- <para>
- Initializes a new instance of the <see cref="T:log4net.Core.LogException"/> class
- with the specified message and inner exception.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Core.LogException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Serialization constructor
- </summary>
- <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
- <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
- <remarks>
- <para>
- Initializes a new instance of the <see cref="T:log4net.Core.LogException"/> class
- with serialized data.
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Appender.FileAppender.LockingModelBase">
- <summary>
- Locking model base class
- </summary>
- <remarks>
- <para>
- Base class for the locking models available to the <see cref="T:log4net.Appender.FileAppender"/> derived loggers.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.FileAppender.LockingModelBase.OpenFile(System.String,System.Boolean,System.Text.Encoding)">
- <summary>
- Open the output file
- </summary>
- <param name="filename">The filename to use</param>
- <param name="append">Whether to append to the file, or overwrite</param>
- <param name="encoding">The encoding to use</param>
- <remarks>
- <para>
- Open the file specified and prepare for logging.
- No writes will be made until <see cref="M:log4net.Appender.FileAppender.LockingModelBase.AcquireLock"/> is called.
- Must be called before any calls to <see cref="M:log4net.Appender.FileAppender.LockingModelBase.AcquireLock"/>,
- <see cref="M:log4net.Appender.FileAppender.LockingModelBase.ReleaseLock"/> and <see cref="M:log4net.Appender.FileAppender.LockingModelBase.CloseFile"/>.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.FileAppender.LockingModelBase.CloseFile">
- <summary>
- Close the file
- </summary>
- <remarks>
- <para>
- Close the file. No further writes will be made.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.FileAppender.LockingModelBase.AcquireLock">
- <summary>
- Acquire the lock on the file
- </summary>
- <returns>A stream that is ready to be written to.</returns>
- <remarks>
- <para>
- Acquire the lock on the file in preparation for writing to it.
- Return a stream pointing to the file. <see cref="M:log4net.Appender.FileAppender.LockingModelBase.ReleaseLock"/>
- must be called to release the lock on the output file.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.FileAppender.LockingModelBase.ReleaseLock">
- <summary>
- Release the lock on the file
- </summary>
- <remarks>
- <para>
- Release the lock on the file. No further writes will be made to the
- stream until <see cref="M:log4net.Appender.FileAppender.LockingModelBase.AcquireLock"/> is called again.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.FileAppender.LockingModelBase.CreateStream(System.String,System.Boolean,System.IO.FileShare)">
- <summary>
- Helper method that creates a FileStream under CurrentAppender's SecurityContext.
- </summary>
- <remarks>
- <para>
- Typically called during OpenFile or AcquireLock.
- </para>
- <para>
- If the directory portion of the <paramref name="filename"/> does not exist, it is created
- via Directory.CreateDirecctory.
- </para>
- </remarks>
- <param name="filename"></param>
- <param name="append"></param>
- <param name="fileShare"></param>
- <returns></returns>
- </member>
- <member name="M:log4net.Appender.FileAppender.LockingModelBase.CloseStream(System.IO.Stream)">
- <summary>
- Helper method to close <paramref name="stream"/> under CurrentAppender's SecurityContext.
- </summary>
- <remarks>
- Does not set <paramref name="stream"/> to null.
- </remarks>
- <param name="stream"></param>
- </member>
- <member name="P:log4net.Appender.FileAppender.LockingModelBase.CurrentAppender">
- <summary>
- Gets or sets the <see cref="T:log4net.Appender.FileAppender"/> for this LockingModel
- </summary>
- <value>
- The <see cref="T:log4net.Appender.FileAppender"/> for this LockingModel
- </value>
- <remarks>
- <para>
- The file appender this locking model is attached to and working on
- behalf of.
- </para>
- <para>
- The file appender is used to locate the security context and the error handler to use.
- </para>
- <para>
- The value of this property will be set before <see cref="M:log4net.Appender.FileAppender.LockingModelBase.OpenFile(System.String,System.Boolean,System.Text.Encoding)"/> is
- called.
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Appender.FileAppender.ExclusiveLock">
- <summary>
- Hold an exclusive lock on the output file
- </summary>
- <remarks>
- <para>
- Open the file once for writing and hold it open until <see cref="M:log4net.Appender.FileAppender.ExclusiveLock.CloseFile"/> is called.
- Maintains an exclusive lock on the file during this time.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.FileAppender.ExclusiveLock.OpenFile(System.String,System.Boolean,System.Text.Encoding)">
- <summary>
- Open the file specified and prepare for logging.
- </summary>
- <param name="filename">The filename to use</param>
- <param name="append">Whether to append to the file, or overwrite</param>
- <param name="encoding">The encoding to use</param>
- <remarks>
- <para>
- Open the file specified and prepare for logging.
- No writes will be made until <see cref="M:log4net.Appender.FileAppender.ExclusiveLock.AcquireLock"/> is called.
- Must be called before any calls to <see cref="M:log4net.Appender.FileAppender.ExclusiveLock.AcquireLock"/>,
- <see cref="M:log4net.Appender.FileAppender.ExclusiveLock.ReleaseLock"/> and <see cref="M:log4net.Appender.FileAppender.ExclusiveLock.CloseFile"/>.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.FileAppender.ExclusiveLock.CloseFile">
- <summary>
- Close the file
- </summary>
- <remarks>
- <para>
- Close the file. No further writes will be made.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.FileAppender.ExclusiveLock.AcquireLock">
- <summary>
- Acquire the lock on the file
- </summary>
- <returns>A stream that is ready to be written to.</returns>
- <remarks>
- <para>
- Does nothing. The lock is already taken
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.FileAppender.ExclusiveLock.ReleaseLock">
- <summary>
- Release the lock on the file
- </summary>
- <remarks>
- <para>
- Does nothing. The lock will be released when the file is closed.
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Appender.FileAppender.MinimalLock">
- <summary>
- Acquires the file lock for each write
- </summary>
- <remarks>
- <para>
- Opens the file once for each <see cref="M:log4net.Appender.FileAppender.MinimalLock.AcquireLock"/>/<see cref="M:log4net.Appender.FileAppender.MinimalLock.ReleaseLock"/> cycle,
- thus holding the lock for the minimal amount of time. This method of locking
- is considerably slower than <see cref="T:log4net.Appender.FileAppender.ExclusiveLock"/> but allows
- other processes to move/delete the log file whilst logging continues.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.FileAppender.MinimalLock.OpenFile(System.String,System.Boolean,System.Text.Encoding)">
- <summary>
- Prepares to open the file when the first message is logged.
- </summary>
- <param name="filename">The filename to use</param>
- <param name="append">Whether to append to the file, or overwrite</param>
- <param name="encoding">The encoding to use</param>
- <remarks>
- <para>
- Open the file specified and prepare for logging.
- No writes will be made until <see cref="M:log4net.Appender.FileAppender.MinimalLock.AcquireLock"/> is called.
- Must be called before any calls to <see cref="M:log4net.Appender.FileAppender.MinimalLock.AcquireLock"/>,
- <see cref="M:log4net.Appender.FileAppender.MinimalLock.ReleaseLock"/> and <see cref="M:log4net.Appender.FileAppender.MinimalLock.CloseFile"/>.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.FileAppender.MinimalLock.CloseFile">
- <summary>
- Close the file
- </summary>
- <remarks>
- <para>
- Close the file. No further writes will be made.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.FileAppender.MinimalLock.AcquireLock">
- <summary>
- Acquire the lock on the file
- </summary>
- <returns>A stream that is ready to be written to.</returns>
- <remarks>
- <para>
- Acquire the lock on the file in preparation for writing to it.
- Return a stream pointing to the file. <see cref="M:log4net.Appender.FileAppender.MinimalLock.ReleaseLock"/>
- must be called to release the lock on the output file.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.FileAppender.MinimalLock.ReleaseLock">
- <summary>
- Release the lock on the file
- </summary>
- <remarks>
- <para>
- Release the lock on the file. No further writes will be made to the
- stream until <see cref="M:log4net.Appender.FileAppender.MinimalLock.AcquireLock"/> is called again.
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Appender.FileAppender.InterProcessLock">
- <summary>
- Provides cross-process file locking.
- </summary>
- <author>Ron Grabowski</author>
- <author>Steve Wranovsky</author>
- </member>
- <member name="M:log4net.Appender.FileAppender.InterProcessLock.OpenFile(System.String,System.Boolean,System.Text.Encoding)">
- <summary>
- Open the file specified and prepare for logging.
- </summary>
- <param name="filename">The filename to use</param>
- <param name="append">Whether to append to the file, or overwrite</param>
- <param name="encoding">The encoding to use</param>
- <remarks>
- <para>
- Open the file specified and prepare for logging.
- No writes will be made until <see cref="M:log4net.Appender.FileAppender.InterProcessLock.AcquireLock"/> is called.
- Must be called before any calls to <see cref="M:log4net.Appender.FileAppender.InterProcessLock.AcquireLock"/>,
- -<see cref="M:log4net.Appender.FileAppender.InterProcessLock.ReleaseLock"/> and <see cref="M:log4net.Appender.FileAppender.InterProcessLock.CloseFile"/>.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.FileAppender.InterProcessLock.CloseFile">
- <summary>
- Close the file
- </summary>
- <remarks>
- <para>
- Close the file. No further writes will be made.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.FileAppender.InterProcessLock.AcquireLock">
- <summary>
- Acquire the lock on the file
- </summary>
- <returns>A stream that is ready to be written to.</returns>
- <remarks>
- <para>
- Does nothing. The lock is already taken
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.FileAppender.InterProcessLock.ReleaseLock">
- <summary>
-
- </summary>
- </member>
- <member name="T:log4net.Appender.ForwardingAppender">
- <summary>
- This appender forwards logging events to attached appenders.
- </summary>
- <remarks>
- <para>
- The forwarding appender can be used to specify different thresholds
- and filters for the same appender at different locations within the hierarchy.
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- <author>Gert Driesen</author>
- </member>
- <member name="M:log4net.Appender.ForwardingAppender.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:log4net.Appender.ForwardingAppender"/> class.
- </summary>
- <remarks>
- <para>
- Default constructor.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.ForwardingAppender.OnClose">
- <summary>
- Closes the appender and releases resources.
- </summary>
- <remarks>
- <para>
- Releases any resources allocated within the appender such as file handles,
- network connections, etc.
- </para>
- <para>
- It is a programming error to append to a closed appender.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.ForwardingAppender.Append(log4net.Core.LoggingEvent)">
- <summary>
- Forward the logging event to the attached appenders
- </summary>
- <param name="loggingEvent">The event to log.</param>
- <remarks>
- <para>
- Delivers the logging event to all the attached appenders.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.ForwardingAppender.Append(log4net.Core.LoggingEvent[])">
- <summary>
- Forward the logging events to the attached appenders
- </summary>
- <param name="loggingEvents">The array of events to log.</param>
- <remarks>
- <para>
- Delivers the logging events to all the attached appenders.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.ForwardingAppender.AddAppender(log4net.Appender.IAppender)">
- <summary>
- Adds an <see cref="T:log4net.Appender.IAppender"/> to the list of appenders of this
- instance.
- </summary>
- <param name="newAppender">The <see cref="T:log4net.Appender.IAppender"/> to add to this appender.</param>
- <remarks>
- <para>
- If the specified <see cref="T:log4net.Appender.IAppender"/> is already in the list of
- appenders, then it won't be added again.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.ForwardingAppender.GetAppender(System.String)">
- <summary>
- Looks for the appender with the specified name.
- </summary>
- <param name="name">The name of the appender to lookup.</param>
- <returns>
- The appender with the specified name, or <c>null</c>.
- </returns>
- <remarks>
- <para>
- Get the named appender attached to this appender.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.ForwardingAppender.RemoveAllAppenders">
- <summary>
- Removes all previously added appenders from this appender.
- </summary>
- <remarks>
- <para>
- This is useful when re-reading configuration information.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.ForwardingAppender.RemoveAppender(log4net.Appender.IAppender)">
- <summary>
- Removes the specified appender from the list of appenders.
- </summary>
- <param name="appender">The appender to remove.</param>
- <returns>The appender removed from the list</returns>
- <remarks>
- The appender removed is not closed.
- If you are discarding the appender you must call
- <see cref="M:log4net.Appender.IAppender.Close"/> on the appender removed.
- </remarks>
- </member>
- <member name="M:log4net.Appender.ForwardingAppender.RemoveAppender(System.String)">
- <summary>
- Removes the appender with the specified name from the list of appenders.
- </summary>
- <param name="name">The name of the appender to remove.</param>
- <returns>The appender removed from the list</returns>
- <remarks>
- The appender removed is not closed.
- If you are discarding the appender you must call
- <see cref="M:log4net.Appender.IAppender.Close"/> on the appender removed.
- </remarks>
- </member>
- <member name="F:log4net.Appender.ForwardingAppender.m_appenderAttachedImpl">
- <summary>
- Implementation of the <see cref="T:log4net.Core.IAppenderAttachable"/> interface
- </summary>
- </member>
- <member name="P:log4net.Appender.ForwardingAppender.Appenders">
- <summary>
- Gets the appenders contained in this appender as an
- <see cref="T:System.Collections.ICollection"/>.
- </summary>
- <remarks>
- If no appenders can be found, then an <see cref="T:log4net.Util.EmptyCollection"/>
- is returned.
- </remarks>
- <returns>
- A collection of the appenders in this appender.
- </returns>
- </member>
- <member name="T:log4net.Appender.LocalSyslogAppender">
- <summary>
- Logs events to a local syslog service.
- </summary>
- <remarks>
- <note>
- This appender uses the POSIX libc library functions <c>openlog</c>, <c>syslog</c>, and <c>closelog</c>.
- If these functions are not available on the local system then this appender will not work!
- </note>
- <para>
- The functions <c>openlog</c>, <c>syslog</c>, and <c>closelog</c> are specified in SUSv2 and
- POSIX 1003.1-2001 standards. These are used to log messages to the local syslog service.
- </para>
- <para>
- This appender talks to a local syslog service. If you need to log to a remote syslog
- daemon and you cannot configure your local syslog service to do this you may be
- able to use the <see cref="T:log4net.Appender.RemoteSyslogAppender"/> to log via UDP.
- </para>
- <para>
- Syslog messages must have a facility and and a severity. The severity
- is derived from the Level of the logging event.
- The facility must be chosen from the set of defined syslog
- <see cref="T:log4net.Appender.LocalSyslogAppender.SyslogFacility"/> values. The facilities list is predefined
- and cannot be extended.
- </para>
- <para>
- An identifier is specified with each log message. This can be specified
- by setting the <see cref="P:log4net.Appender.LocalSyslogAppender.Identity"/> property. The identity (also know
- as the tag) must not contain white space. The default value for the
- identity is the application name (from <see cref="P:log4net.Util.SystemInfo.ApplicationFriendlyName"/>).
- </para>
- </remarks>
- <author>Rob Lyon</author>
- <author>Nicko Cadell</author>
- </member>
- <member name="M:log4net.Appender.LocalSyslogAppender.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:log4net.Appender.LocalSyslogAppender"/> class.
- </summary>
- <remarks>
- This instance of the <see cref="T:log4net.Appender.LocalSyslogAppender"/> class is set up to write
- to a local syslog service.
- </remarks>
- </member>
- <member name="M:log4net.Appender.LocalSyslogAppender.AddMapping(log4net.Appender.LocalSyslogAppender.LevelSeverity)">
- <summary>
- Add a mapping of level to severity
- </summary>
- <param name="mapping">The mapping to add</param>
- <remarks>
- <para>
- Adds a <see cref="T:log4net.Appender.LocalSyslogAppender.LevelSeverity"/> to this appender.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.LocalSyslogAppender.ActivateOptions">
- <summary>
- Initialize the appender based on the options set.
- </summary>
- <remarks>
- <para>
- This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
- activation scheme. The <see cref="M:log4net.Appender.LocalSyslogAppender.ActivateOptions"/> method must
- be called on this object after the configuration properties have
- been set. Until <see cref="M:log4net.Appender.LocalSyslogAppender.ActivateOptions"/> is called this
- object is in an undefined state and must not be used.
- </para>
- <para>
- If any of the configuration properties are modified then
- <see cref="M:log4net.Appender.LocalSyslogAppender.ActivateOptions"/> must be called again.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.LocalSyslogAppender.Append(log4net.Core.LoggingEvent)">
- <summary>
- This method is called by the <see cref="M:AppenderSkeleton.DoAppend(LoggingEvent)"/> method.
- </summary>
- <param name="loggingEvent">The event to log.</param>
- <remarks>
- <para>
- Writes the event to a remote syslog daemon.
- </para>
- <para>
- The format of the output will depend on the appender's layout.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.LocalSyslogAppender.OnClose">
- <summary>
- Close the syslog when the appender is closed
- </summary>
- <remarks>
- <para>
- Close the syslog when the appender is closed
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.LocalSyslogAppender.GetSeverity(log4net.Core.Level)">
- <summary>
- Translates a log4net level to a syslog severity.
- </summary>
- <param name="level">A log4net level.</param>
- <returns>A syslog severity.</returns>
- <remarks>
- <para>
- Translates a log4net level to a syslog severity.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.LocalSyslogAppender.GeneratePriority(log4net.Appender.LocalSyslogAppender.SyslogFacility,log4net.Appender.LocalSyslogAppender.SyslogSeverity)">
- <summary>
- Generate a syslog priority.
- </summary>
- <param name="facility">The syslog facility.</param>
- <param name="severity">The syslog severity.</param>
- <returns>A syslog priority.</returns>
- </member>
- <member name="F:log4net.Appender.LocalSyslogAppender.m_facility">
- <summary>
- The facility. The default facility is <see cref="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.User"/>.
- </summary>
- </member>
- <member name="F:log4net.Appender.LocalSyslogAppender.m_identity">
- <summary>
- The message identity
- </summary>
- </member>
- <member name="F:log4net.Appender.LocalSyslogAppender.m_handleToIdentity">
- <summary>
- Marshaled handle to the identity string. We have to hold on to the
- string as the <c>openlog</c> and <c>syslog</c> APIs just hold the
- pointer to the ident and dereference it for each log message.
- </summary>
- </member>
- <member name="F:log4net.Appender.LocalSyslogAppender.m_levelMapping">
- <summary>
- Mapping from level object to syslog severity
- </summary>
- </member>
- <member name="M:log4net.Appender.LocalSyslogAppender.openlog(System.IntPtr,System.Int32,log4net.Appender.LocalSyslogAppender.SyslogFacility)">
- <summary>
- Open connection to system logger.
- </summary>
- </member>
- <member name="M:log4net.Appender.LocalSyslogAppender.syslog(System.Int32,System.String,System.String)">
- <summary>
- Generate a log message.
- </summary>
- <remarks>
- <para>
- The libc syslog method takes a format string and a variable argument list similar
- to the classic printf function. As this type of vararg list is not supported
- by C# we need to specify the arguments explicitly. Here we have specified the
- format string with a single message argument. The caller must set the format
- string to <c>"%s"</c>.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.LocalSyslogAppender.closelog">
- <summary>
- Close descriptor used to write to system logger.
- </summary>
- </member>
- <member name="P:log4net.Appender.LocalSyslogAppender.Identity">
- <summary>
- Message identity
- </summary>
- <remarks>
- <para>
- An identifier is specified with each log message. This can be specified
- by setting the <see cref="P:log4net.Appender.LocalSyslogAppender.Identity"/> property. The identity (also know
- as the tag) must not contain white space. The default value for the
- identity is the application name (from <see cref="P:log4net.Util.SystemInfo.ApplicationFriendlyName"/>).
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Appender.LocalSyslogAppender.Facility">
- <summary>
- Syslog facility
- </summary>
- <remarks>
- Set to one of the <see cref="T:log4net.Appender.LocalSyslogAppender.SyslogFacility"/> values. The list of
- facilities is predefined and cannot be extended. The default value
- is <see cref="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.User"/>.
- </remarks>
- </member>
- <member name="P:log4net.Appender.LocalSyslogAppender.RequiresLayout">
- <summary>
- This appender requires a <see cref="P:log4net.Appender.AppenderSkeleton.Layout"/> to be set.
- </summary>
- <value><c>true</c></value>
- <remarks>
- <para>
- This appender requires a <see cref="P:log4net.Appender.AppenderSkeleton.Layout"/> to be set.
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Appender.LocalSyslogAppender.SyslogSeverity">
- <summary>
- syslog severities
- </summary>
- <remarks>
- <para>
- The log4net Level maps to a syslog severity using the
- <see cref="M:log4net.Appender.LocalSyslogAppender.AddMapping(log4net.Appender.LocalSyslogAppender.LevelSeverity)"/> method and the <see cref="T:log4net.Appender.LocalSyslogAppender.LevelSeverity"/>
- class. The severity is set on <see cref="P:log4net.Appender.LocalSyslogAppender.LevelSeverity.Severity"/>.
- </para>
- </remarks>
- </member>
- <member name="F:log4net.Appender.LocalSyslogAppender.SyslogSeverity.Emergency">
- <summary>
- system is unusable
- </summary>
- </member>
- <member name="F:log4net.Appender.LocalSyslogAppender.SyslogSeverity.Alert">
- <summary>
- action must be taken immediately
- </summary>
- </member>
- <member name="F:log4net.Appender.LocalSyslogAppender.SyslogSeverity.Critical">
- <summary>
- critical conditions
- </summary>
- </member>
- <member name="F:log4net.Appender.LocalSyslogAppender.SyslogSeverity.Error">
- <summary>
- error conditions
- </summary>
- </member>
- <member name="F:log4net.Appender.LocalSyslogAppender.SyslogSeverity.Warning">
- <summary>
- warning conditions
- </summary>
- </member>
- <member name="F:log4net.Appender.LocalSyslogAppender.SyslogSeverity.Notice">
- <summary>
- normal but significant condition
- </summary>
- </member>
- <member name="F:log4net.Appender.LocalSyslogAppender.SyslogSeverity.Informational">
- <summary>
- informational
- </summary>
- </member>
- <member name="F:log4net.Appender.LocalSyslogAppender.SyslogSeverity.Debug">
- <summary>
- debug-level messages
- </summary>
- </member>
- <member name="T:log4net.Appender.LocalSyslogAppender.SyslogFacility">
- <summary>
- syslog facilities
- </summary>
- <remarks>
- <para>
- The syslog facility defines which subsystem the logging comes from.
- This is set on the <see cref="P:log4net.Appender.LocalSyslogAppender.Facility"/> property.
- </para>
- </remarks>
- </member>
- <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Kernel">
- <summary>
- kernel messages
- </summary>
- </member>
- <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.User">
- <summary>
- random user-level messages
- </summary>
- </member>
- <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Mail">
- <summary>
- mail system
- </summary>
- </member>
- <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Daemons">
- <summary>
- system daemons
- </summary>
- </member>
- <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Authorization">
- <summary>
- security/authorization messages
- </summary>
- </member>
- <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Syslog">
- <summary>
- messages generated internally by syslogd
- </summary>
- </member>
- <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Printer">
- <summary>
- line printer subsystem
- </summary>
- </member>
- <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.News">
- <summary>
- network news subsystem
- </summary>
- </member>
- <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Uucp">
- <summary>
- UUCP subsystem
- </summary>
- </member>
- <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Clock">
- <summary>
- clock (cron/at) daemon
- </summary>
- </member>
- <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Authorization2">
- <summary>
- security/authorization messages (private)
- </summary>
- </member>
- <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Ftp">
- <summary>
- ftp daemon
- </summary>
- </member>
- <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Ntp">
- <summary>
- NTP subsystem
- </summary>
- </member>
- <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Audit">
- <summary>
- log audit
- </summary>
- </member>
- <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Alert">
- <summary>
- log alert
- </summary>
- </member>
- <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Clock2">
- <summary>
- clock daemon
- </summary>
- </member>
- <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Local0">
- <summary>
- reserved for local use
- </summary>
- </member>
- <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Local1">
- <summary>
- reserved for local use
- </summary>
- </member>
- <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Local2">
- <summary>
- reserved for local use
- </summary>
- </member>
- <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Local3">
- <summary>
- reserved for local use
- </summary>
- </member>
- <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Local4">
- <summary>
- reserved for local use
- </summary>
- </member>
- <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Local5">
- <summary>
- reserved for local use
- </summary>
- </member>
- <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Local6">
- <summary>
- reserved for local use
- </summary>
- </member>
- <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Local7">
- <summary>
- reserved for local use
- </summary>
- </member>
- <member name="T:log4net.Appender.LocalSyslogAppender.LevelSeverity">
- <summary>
- A class to act as a mapping between the level that a logging call is made at and
- the syslog severity that is should be logged at.
- </summary>
- <remarks>
- <para>
- A class to act as a mapping between the level that a logging call is made at and
- the syslog severity that is should be logged at.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Appender.LocalSyslogAppender.LevelSeverity.Severity">
- <summary>
- The mapped syslog severity for the specified level
- </summary>
- <remarks>
- <para>
- Required property.
- The mapped syslog severity for the specified level
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Appender.ManagedColoredConsoleAppender">
- <summary>
- Appends colorful logging events to the console, using the .NET 2
- built-in capabilities.
- </summary>
- <remarks>
- <para>
- ManagedColoredConsoleAppender appends log events to the standard output stream
- or the error output stream using a layout specified by the
- user. It also allows the color of a specific type of message to be set.
- </para>
- <para>
- By default, all output is written to the console's standard output stream.
- The <see cref="P:log4net.Appender.ManagedColoredConsoleAppender.Target"/> property can be set to direct the output to the
- error stream.
- </para>
- <para>
- When configuring the colored console appender, mappings should be
- specified to map logging levels to colors. For example:
- </para>
- <code lang="XML" escaped="true">
- <mapping>
- <level value="ERROR"/>
- <foreColor value="DarkRed"/>
- <backColor value="White"/>
- </mapping>
- <mapping>
- <level value="WARN"/>
- <foreColor value="Yellow"/>
- </mapping>
- <mapping>
- <level value="INFO"/>
- <foreColor value="White"/>
- </mapping>
- <mapping>
- <level value="DEBUG"/>
- <foreColor value="Blue"/>
- </mapping>
- </code>
- <para>
- The Level is the standard log4net logging level while
- ForeColor and BackColor are the values of <see cref="T:System.ConsoleColor"/>
- enumeration.
- </para>
- <para>
- Based on the ColoredConsoleAppender
- </para>
- </remarks>
- <author>Rick Hobbs</author>
- <author>Nicko Cadell</author>
- <author>Pavlos Touboulidis</author>
- </member>
- <member name="F:log4net.Appender.ManagedColoredConsoleAppender.ConsoleOut">
- <summary>
- The <see cref="P:log4net.Appender.ManagedColoredConsoleAppender.Target"/> to use when writing to the Console
- standard output stream.
- </summary>
- <remarks>
- <para>
- The <see cref="P:log4net.Appender.ManagedColoredConsoleAppender.Target"/> to use when writing to the Console
- standard output stream.
- </para>
- </remarks>
- </member>
- <member name="F:log4net.Appender.ManagedColoredConsoleAppender.ConsoleError">
- <summary>
- The <see cref="P:log4net.Appender.ManagedColoredConsoleAppender.Target"/> to use when writing to the Console
- standard error output stream.
- </summary>
- <remarks>
- <para>
- The <see cref="P:log4net.Appender.ManagedColoredConsoleAppender.Target"/> to use when writing to the Console
- standard error output stream.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.ManagedColoredConsoleAppender.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:log4net.Appender.ManagedColoredConsoleAppender"/> class.
- </summary>
- <remarks>
- The instance of the <see cref="T:log4net.Appender.ManagedColoredConsoleAppender"/> class is set up to write
- to the standard output stream.
- </remarks>
- </member>
- <member name="M:log4net.Appender.ManagedColoredConsoleAppender.AddMapping(log4net.Appender.ManagedColoredConsoleAppender.LevelColors)">
- <summary>
- Add a mapping of level to color - done by the config file
- </summary>
- <param name="mapping">The mapping to add</param>
- <remarks>
- <para>
- Add a <see cref="T:log4net.Appender.ManagedColoredConsoleAppender.LevelColors"/> mapping to this appender.
- Each mapping defines the foreground and background colors
- for a level.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.ManagedColoredConsoleAppender.Append(log4net.Core.LoggingEvent)">
- <summary>
- This method is called by the <see cref="M:AppenderSkeleton.DoAppend(log4net.Core.LoggingEvent)"/> method.
- </summary>
- <param name="loggingEvent">The event to log.</param>
- <remarks>
- <para>
- Writes the event to the console.
- </para>
- <para>
- The format of the output will depend on the appender's layout.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.ManagedColoredConsoleAppender.ActivateOptions">
- <summary>
- Initialize the options for this appender
- </summary>
- <remarks>
- <para>
- Initialize the level to color mappings set on this appender.
- </para>
- </remarks>
- </member>
- <member name="F:log4net.Appender.ManagedColoredConsoleAppender.m_writeToErrorStream">
- <summary>
- Flag to write output to the error stream rather than the standard output stream
- </summary>
- </member>
- <member name="F:log4net.Appender.ManagedColoredConsoleAppender.m_levelMapping">
- <summary>
- Mapping from level object to color value
- </summary>
- </member>
- <member name="P:log4net.Appender.ManagedColoredConsoleAppender.Target">
- <summary>
- Target is the value of the console output stream.
- This is either <c>"Console.Out"</c> or <c>"Console.Error"</c>.
- </summary>
- <value>
- Target is the value of the console output stream.
- This is either <c>"Console.Out"</c> or <c>"Console.Error"</c>.
- </value>
- <remarks>
- <para>
- Target is the value of the console output stream.
- This is either <c>"Console.Out"</c> or <c>"Console.Error"</c>.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Appender.ManagedColoredConsoleAppender.RequiresLayout">
- <summary>
- This appender requires a <see cref="N:log4net.Layout"/> to be set.
- </summary>
- <value><c>true</c></value>
- <remarks>
- <para>
- This appender requires a <see cref="N:log4net.Layout"/> to be set.
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Appender.ManagedColoredConsoleAppender.LevelColors">
- <summary>
- A class to act as a mapping between the level that a logging call is made at and
- the color it should be displayed as.
- </summary>
- <remarks>
- <para>
- Defines the mapping between a level and the color it should be displayed in.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Appender.ManagedColoredConsoleAppender.LevelColors.ForeColor">
- <summary>
- The mapped foreground color for the specified level
- </summary>
- <remarks>
- <para>
- Required property.
- The mapped foreground color for the specified level.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Appender.ManagedColoredConsoleAppender.LevelColors.BackColor">
- <summary>
- The mapped background color for the specified level
- </summary>
- <remarks>
- <para>
- Required property.
- The mapped background color for the specified level.
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Appender.MemoryAppender">
- <summary>
- Stores logging events in an array.
- </summary>
- <remarks>
- <para>
- The memory appender stores all the logging events
- that are appended in an in-memory array.
- </para>
- <para>
- Use the <see cref="M:log4net.Appender.MemoryAppender.GetEvents"/> method to get
- the current list of events that have been appended.
- </para>
- <para>
- Use the <see cref="M:Clear()"/> method to clear the
- current list of events.
- </para>
- </remarks>
- <author>Julian Biddle</author>
- <author>Nicko Cadell</author>
- <author>Gert Driesen</author>
- </member>
- <member name="M:log4net.Appender.MemoryAppender.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:log4net.Appender.MemoryAppender"/> class.
- </summary>
- <remarks>
- <para>
- Default constructor.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.MemoryAppender.GetEvents">
- <summary>
- Gets the events that have been logged.
- </summary>
- <returns>The events that have been logged</returns>
- <remarks>
- <para>
- Gets the events that have been logged.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.MemoryAppender.Append(log4net.Core.LoggingEvent)">
- <summary>
- This method is called by the <see cref="M:AppenderSkeleton.DoAppend(LoggingEvent)"/> method.
- </summary>
- <param name="loggingEvent">the event to log</param>
- <remarks>
- <para>Stores the <paramref name="loggingEvent"/> in the events list.</para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.MemoryAppender.Clear">
- <summary>
- Clear the list of events
- </summary>
- <remarks>
- Clear the list of events
- </remarks>
- </member>
- <member name="F:log4net.Appender.MemoryAppender.m_eventsList">
- <summary>
- The list of events that have been appended.
- </summary>
- </member>
- <member name="F:log4net.Appender.MemoryAppender.m_fixFlags">
- <summary>
- Value indicating which fields in the event should be fixed
- </summary>
- <remarks>
- By default all fields are fixed
- </remarks>
- </member>
- <member name="P:log4net.Appender.MemoryAppender.OnlyFixPartialEventData">
- <summary>
- Gets or sets a value indicating whether only part of the logging event
- data should be fixed.
- </summary>
- <value>
- <c>true</c> if the appender should only fix part of the logging event
- data, otherwise <c>false</c>. The default is <c>false</c>.
- </value>
- <remarks>
- <para>
- Setting this property to <c>true</c> will cause only part of the event
- data to be fixed and stored in the appender, hereby improving performance.
- </para>
- <para>
- See <see cref="M:LoggingEvent.FixVolatileData(bool)"/> for more information.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Appender.MemoryAppender.Fix">
- <summary>
- Gets or sets the fields that will be fixed in the event
- </summary>
- <remarks>
- <para>
- The logging event needs to have certain thread specific values
- captured before it can be buffered. See <see cref="P:log4net.Core.LoggingEvent.Fix"/>
- for details.
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Appender.NetSendAppender">
- <summary>
- Logs entries by sending network messages using the
- <see cref="M:log4net.Appender.NetSendAppender.NetMessageBufferSend(System.String,System.String,System.String,System.String,System.Int32)"/> native function.
- </summary>
- <remarks>
- <para>
- You can send messages only to names that are active
- on the network. If you send the message to a user name,
- that user must be logged on and running the Messenger
- service to receive the message.
- </para>
- <para>
- The receiver will get a top most window displaying the
- messages one at a time, therefore this appender should
- not be used to deliver a high volume of messages.
- </para>
- <para>
- The following table lists some possible uses for this appender :
- </para>
- <para>
- <list type="table">
- <listheader>
- <term>Action</term>
- <description>Property Value(s)</description>
- </listheader>
- <item>
- <term>Send a message to a user account on the local machine</term>
- <description>
- <para>
- <see cref="P:log4net.Appender.NetSendAppender.Server"/> = <name of the local machine>
- </para>
- <para>
- <see cref="P:log4net.Appender.NetSendAppender.Recipient"/> = <user name>
- </para>
- </description>
- </item>
- <item>
- <term>Send a message to a user account on a remote machine</term>
- <description>
- <para>
- <see cref="P:log4net.Appender.NetSendAppender.Server"/> = <name of the remote machine>
- </para>
- <para>
- <see cref="P:log4net.Appender.NetSendAppender.Recipient"/> = <user name>
- </para>
- </description>
- </item>
- <item>
- <term>Send a message to a domain user account</term>
- <description>
- <para>
- <see cref="P:log4net.Appender.NetSendAppender.Server"/> = <name of a domain controller | uninitialized>
- </para>
- <para>
- <see cref="P:log4net.Appender.NetSendAppender.Recipient"/> = <user name>
- </para>
- </description>
- </item>
- <item>
- <term>Send a message to all the names in a workgroup or domain</term>
- <description>
- <para>
- <see cref="P:log4net.Appender.NetSendAppender.Recipient"/> = <workgroup name | domain name>*
- </para>
- </description>
- </item>
- <item>
- <term>Send a message from the local machine to a remote machine</term>
- <description>
- <para>
- <see cref="P:log4net.Appender.NetSendAppender.Server"/> = <name of the local machine | uninitialized>
- </para>
- <para>
- <see cref="P:log4net.Appender.NetSendAppender.Recipient"/> = <name of the remote machine>
- </para>
- </description>
- </item>
- </list>
- </para>
- <para>
- <b>Note :</b> security restrictions apply for sending
- network messages, see <see cref="M:log4net.Appender.NetSendAppender.NetMessageBufferSend(System.String,System.String,System.String,System.String,System.Int32)"/>
- for more information.
- </para>
- </remarks>
- <example>
- <para>
- An example configuration section to log information
- using this appender from the local machine, named
- LOCAL_PC, to machine OPERATOR_PC :
- </para>
- <code lang="XML" escaped="true">
- <appender name="NetSendAppender_Operator" type="log4net.Appender.NetSendAppender">
- <server value="LOCAL_PC"/>
- <recipient value="OPERATOR_PC"/>
- <layout type="log4net.Layout.PatternLayout" value="%-5p %c [%x] - %m%n"/>
- </appender>
- </code>
- </example>
- <author>Nicko Cadell</author>
- <author>Gert Driesen</author>
- </member>
- <member name="F:log4net.Appender.NetSendAppender.m_server">
- <summary>
- The DNS or NetBIOS name of the server on which the function is to execute.
- </summary>
- </member>
- <member name="F:log4net.Appender.NetSendAppender.m_sender">
- <summary>
- The sender of the network message.
- </summary>
- </member>
- <member name="F:log4net.Appender.NetSendAppender.m_recipient">
- <summary>
- The message alias to which the message should be sent.
- </summary>
- </member>
- <member name="F:log4net.Appender.NetSendAppender.m_securityContext">
- <summary>
- The security context to use for privileged calls
- </summary>
- </member>
- <member name="M:log4net.Appender.NetSendAppender.#ctor">
- <summary>
- Initializes the appender.
- </summary>
- <remarks>
- The default constructor initializes all fields to their default values.
- </remarks>
- </member>
- <member name="M:log4net.Appender.NetSendAppender.ActivateOptions">
- <summary>
- Initialize the appender based on the options set.
- </summary>
- <remarks>
- <para>
- This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
- activation scheme. The <see cref="M:log4net.Appender.NetSendAppender.ActivateOptions"/> method must
- be called on this object after the configuration properties have
- been set. Until <see cref="M:log4net.Appender.NetSendAppender.ActivateOptions"/> is called this
- object is in an undefined state and must not be used.
- </para>
- <para>
- If any of the configuration properties are modified then
- <see cref="M:log4net.Appender.NetSendAppender.ActivateOptions"/> must be called again.
- </para>
- <para>
- The appender will be ignored if no <see cref="P:log4net.Appender.NetSendAppender.Recipient"/> was specified.
- </para>
- </remarks>
- <exception cref="T:System.ArgumentNullException">The required property <see cref="P:log4net.Appender.NetSendAppender.Recipient"/> was not specified.</exception>
- </member>
- <member name="M:log4net.Appender.NetSendAppender.Append(log4net.Core.LoggingEvent)">
- <summary>
- This method is called by the <see cref="M:AppenderSkeleton.DoAppend(LoggingEvent)"/> method.
- </summary>
- <param name="loggingEvent">The event to log.</param>
- <remarks>
- <para>
- Sends the event using a network message.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.NetSendAppender.NetMessageBufferSend(System.String,System.String,System.String,System.String,System.Int32)">
- <summary>
- Sends a buffer of information to a registered message alias.
- </summary>
- <param name="serverName">The DNS or NetBIOS name of the server on which the function is to execute.</param>
- <param name="msgName">The message alias to which the message buffer should be sent</param>
- <param name="fromName">The originator of the message.</param>
- <param name="buffer">The message text.</param>
- <param name="bufferSize">The length, in bytes, of the message text.</param>
- <remarks>
- <para>
- The following restrictions apply for sending network messages:
- </para>
- <para>
- <list type="table">
- <listheader>
- <term>Platform</term>
- <description>Requirements</description>
- </listheader>
- <item>
- <term>Windows NT</term>
- <description>
- <para>
- No special group membership is required to send a network message.
- </para>
- <para>
- Admin, Accounts, Print, or Server Operator group membership is required to
- successfully send a network message on a remote server.
- </para>
- </description>
- </item>
- <item>
- <term>Windows 2000 or later</term>
- <description>
- <para>
- If you send a message on a domain controller that is running Active Directory,
- access is allowed or denied based on the access control list (ACL) for the securable
- object. The default ACL permits only Domain Admins and Account Operators to send a network message.
- </para>
- <para>
- On a member server or workstation, only Administrators and Server Operators can send a network message.
- </para>
- </description>
- </item>
- </list>
- </para>
- <para>
- For more information see <a href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/netmgmt/netmgmt/security_requirements_for_the_network_management_functions.asp">Security Requirements for the Network Management Functions</a>.
- </para>
- </remarks>
- <returns>
- <para>
- If the function succeeds, the return value is zero.
- </para>
- </returns>
- </member>
- <member name="P:log4net.Appender.NetSendAppender.Sender">
- <summary>
- Gets or sets the sender of the message.
- </summary>
- <value>
- The sender of the message.
- </value>
- <remarks>
- If this property is not specified, the message is sent from the local computer.
- </remarks>
- </member>
- <member name="P:log4net.Appender.NetSendAppender.Recipient">
- <summary>
- Gets or sets the message alias to which the message should be sent.
- </summary>
- <value>
- The recipient of the message.
- </value>
- <remarks>
- This property should always be specified in order to send a message.
- </remarks>
- </member>
- <member name="P:log4net.Appender.NetSendAppender.Server">
- <summary>
- Gets or sets the DNS or NetBIOS name of the remote server on which the function is to execute.
- </summary>
- <value>
- DNS or NetBIOS name of the remote server on which the function is to execute.
- </value>
- <remarks>
- <para>
- For Windows NT 4.0 and earlier, the string should begin with \\.
- </para>
- <para>
- If this property is not specified, the local computer is used.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Appender.NetSendAppender.SecurityContext">
- <summary>
- Gets or sets the <see cref="P:log4net.Appender.NetSendAppender.SecurityContext"/> used to call the NetSend method.
- </summary>
- <value>
- The <see cref="P:log4net.Appender.NetSendAppender.SecurityContext"/> used to call the NetSend method.
- </value>
- <remarks>
- <para>
- Unless a <see cref="P:log4net.Appender.NetSendAppender.SecurityContext"/> specified here for this appender
- the <see cref="P:log4net.Core.SecurityContextProvider.DefaultProvider"/> is queried for the
- security context to use. The default behavior is to use the security context
- of the current thread.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Appender.NetSendAppender.RequiresLayout">
- <summary>
- This appender requires a <see cref="N:log4net.Layout"/> to be set.
- </summary>
- <value><c>true</c></value>
- <remarks>
- <para>
- This appender requires a <see cref="N:log4net.Layout"/> to be set.
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Appender.OutputDebugStringAppender">
- <summary>
- Appends log events to the OutputDebugString system.
- </summary>
- <remarks>
- <para>
- OutputDebugStringAppender appends log events to the
- OutputDebugString system.
- </para>
- <para>
- The string is passed to the native <c>OutputDebugString</c>
- function.
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- <author>Gert Driesen</author>
- </member>
- <member name="M:log4net.Appender.OutputDebugStringAppender.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:log4net.Appender.OutputDebugStringAppender"/> class.
- </summary>
- <remarks>
- <para>
- Default constructor.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.OutputDebugStringAppender.Append(log4net.Core.LoggingEvent)">
- <summary>
- Write the logging event to the output debug string API
- </summary>
- <param name="loggingEvent">the event to log</param>
- <remarks>
- <para>
- Write the logging event to the output debug string API
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.OutputDebugStringAppender.OutputDebugString(System.String)">
- <summary>
- Stub for OutputDebugString native method
- </summary>
- <param name="message">the string to output</param>
- <remarks>
- <para>
- Stub for OutputDebugString native method
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Appender.OutputDebugStringAppender.RequiresLayout">
- <summary>
- This appender requires a <see cref="N:log4net.Layout"/> to be set.
- </summary>
- <value><c>true</c></value>
- <remarks>
- <para>
- This appender requires a <see cref="N:log4net.Layout"/> to be set.
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Appender.RemoteSyslogAppender">
- <summary>
- Logs events to a remote syslog daemon.
- </summary>
- <remarks>
- <para>
- The BSD syslog protocol is used to remotely log to
- a syslog daemon. The syslogd listens for for messages
- on UDP port 514.
- </para>
- <para>
- The syslog UDP protocol is not authenticated. Most syslog daemons
- do not accept remote log messages because of the security implications.
- You may be able to use the LocalSyslogAppender to talk to a local
- syslog service.
- </para>
- <para>
- There is an RFC 3164 that claims to document the BSD Syslog Protocol.
- This RFC can be seen here: http://www.faqs.org/rfcs/rfc3164.html.
- This appender generates what the RFC calls an "Original Device Message",
- i.e. does not include the TIMESTAMP or HOSTNAME fields. By observation
- this format of message will be accepted by all current syslog daemon
- implementations. The daemon will attach the current time and the source
- hostname or IP address to any messages received.
- </para>
- <para>
- Syslog messages must have a facility and and a severity. The severity
- is derived from the Level of the logging event.
- The facility must be chosen from the set of defined syslog
- <see cref="T:log4net.Appender.RemoteSyslogAppender.SyslogFacility"/> values. The facilities list is predefined
- and cannot be extended.
- </para>
- <para>
- An identifier is specified with each log message. This can be specified
- by setting the <see cref="P:log4net.Appender.RemoteSyslogAppender.Identity"/> property. The identity (also know
- as the tag) must not contain white space. The default value for the
- identity is the application name (from <see cref="P:log4net.Core.LoggingEvent.Domain"/>).
- </para>
- </remarks>
- <author>Rob Lyon</author>
- <author>Nicko Cadell</author>
- </member>
- <member name="T:log4net.Appender.UdpAppender">
- <summary>
- Sends logging events as connectionless UDP datagrams to a remote host or a
- multicast group using an <see cref="T:System.Net.Sockets.UdpClient"/>.
- </summary>
- <remarks>
- <para>
- UDP guarantees neither that messages arrive, nor that they arrive in the correct order.
- </para>
- <para>
- To view the logging results, a custom application can be developed that listens for logging
- events.
- </para>
- <para>
- When decoding events send via this appender remember to use the same encoding
- to decode the events as was used to send the events. See the <see cref="P:log4net.Appender.UdpAppender.Encoding"/>
- property to specify the encoding to use.
- </para>
- </remarks>
- <example>
- This example shows how to log receive logging events that are sent
- on IP address 244.0.0.1 and port 8080 to the console. The event is
- encoded in the packet as a unicode string and it is decoded as such.
- <code lang="C#">
- IPEndPoint remoteEndPoint = new IPEndPoint(IPAddress.Any, 0);
- UdpClient udpClient;
- byte[] buffer;
- string loggingEvent;
-
- try
- {
- udpClient = new UdpClient(8080);
-
- while(true)
- {
- buffer = udpClient.Receive(ref remoteEndPoint);
- loggingEvent = System.Text.Encoding.Unicode.GetString(buffer);
- Console.WriteLine(loggingEvent);
- }
- }
- catch(Exception e)
- {
- Console.WriteLine(e.ToString());
- }
- </code>
- <code lang="Visual Basic">
- Dim remoteEndPoint as IPEndPoint
- Dim udpClient as UdpClient
- Dim buffer as Byte()
- Dim loggingEvent as String
-
- Try
- remoteEndPoint = new IPEndPoint(IPAddress.Any, 0)
- udpClient = new UdpClient(8080)
-
- While True
- buffer = udpClient.Receive(ByRef remoteEndPoint)
- loggingEvent = System.Text.Encoding.Unicode.GetString(buffer)
- Console.WriteLine(loggingEvent)
- Wend
- Catch e As Exception
- Console.WriteLine(e.ToString())
- End Try
- </code>
- <para>
- An example configuration section to log information using this appender to the
- IP 224.0.0.1 on port 8080:
- </para>
- <code lang="XML" escaped="true">
- <appender name="UdpAppender" type="log4net.Appender.UdpAppender">
- <remoteAddress value="224.0.0.1"/>
- <remotePort value="8080"/>
- <layout type="log4net.Layout.PatternLayout" value="%-5level %logger [%ndc] - %message%newline"/>
- </appender>
- </code>
- </example>
- <author>Gert Driesen</author>
- <author>Nicko Cadell</author>
- </member>
- <member name="M:log4net.Appender.UdpAppender.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:log4net.Appender.UdpAppender"/> class.
- </summary>
- <remarks>
- The default constructor initializes all fields to their default values.
- </remarks>
- </member>
- <member name="M:log4net.Appender.UdpAppender.ActivateOptions">
- <summary>
- Initialize the appender based on the options set.
- </summary>
- <remarks>
- <para>
- This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
- activation scheme. The <see cref="M:log4net.Appender.UdpAppender.ActivateOptions"/> method must
- be called on this object after the configuration properties have
- been set. Until <see cref="M:log4net.Appender.UdpAppender.ActivateOptions"/> is called this
- object is in an undefined state and must not be used.
- </para>
- <para>
- If any of the configuration properties are modified then
- <see cref="M:log4net.Appender.UdpAppender.ActivateOptions"/> must be called again.
- </para>
- <para>
- The appender will be ignored if no <see cref="P:log4net.Appender.UdpAppender.RemoteAddress"/> was specified or
- an invalid remote or local TCP port number was specified.
- </para>
- </remarks>
- <exception cref="T:System.ArgumentNullException">The required property <see cref="P:log4net.Appender.UdpAppender.RemoteAddress"/> was not specified.</exception>
- <exception cref="T:System.ArgumentOutOfRangeException">The TCP port number assigned to <see cref="P:log4net.Appender.UdpAppender.LocalPort"/> or <see cref="P:log4net.Appender.UdpAppender.RemotePort"/> is less than <see cref="F:System.Net.IPEndPoint.MinPort"/> or greater than <see cref="F:System.Net.IPEndPoint.MaxPort"/>.</exception>
- </member>
- <member name="M:log4net.Appender.UdpAppender.Append(log4net.Core.LoggingEvent)">
- <summary>
- This method is called by the <see cref="M:AppenderSkeleton.DoAppend(LoggingEvent)"/> method.
- </summary>
- <param name="loggingEvent">The event to log.</param>
- <remarks>
- <para>
- Sends the event using an UDP datagram.
- </para>
- <para>
- Exceptions are passed to the <see cref="P:log4net.Appender.AppenderSkeleton.ErrorHandler"/>.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.UdpAppender.OnClose">
- <summary>
- Closes the UDP connection and releases all resources associated with
- this <see cref="T:log4net.Appender.UdpAppender"/> instance.
- </summary>
- <remarks>
- <para>
- Disables the underlying <see cref="T:System.Net.Sockets.UdpClient"/> and releases all managed
- and unmanaged resources associated with the <see cref="T:log4net.Appender.UdpAppender"/>.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.UdpAppender.InitializeClientConnection">
- <summary>
- Initializes the underlying <see cref="T:System.Net.Sockets.UdpClient"/> connection.
- </summary>
- <remarks>
- <para>
- The underlying <see cref="T:System.Net.Sockets.UdpClient"/> is initialized and binds to the
- port number from which you intend to communicate.
- </para>
- <para>
- Exceptions are passed to the <see cref="P:log4net.Appender.AppenderSkeleton.ErrorHandler"/>.
- </para>
- </remarks>
- </member>
- <member name="F:log4net.Appender.UdpAppender.m_remoteAddress">
- <summary>
- The IP address of the remote host or multicast group to which
- the logging event will be sent.
- </summary>
- </member>
- <member name="F:log4net.Appender.UdpAppender.m_remotePort">
- <summary>
- The TCP port number of the remote host or multicast group to
- which the logging event will be sent.
- </summary>
- </member>
- <member name="F:log4net.Appender.UdpAppender.m_remoteEndPoint">
- <summary>
- The cached remote endpoint to which the logging events will be sent.
- </summary>
- </member>
- <member name="F:log4net.Appender.UdpAppender.m_localPort">
- <summary>
- The TCP port number from which the <see cref="T:System.Net.Sockets.UdpClient"/> will communicate.
- </summary>
- </member>
- <member name="F:log4net.Appender.UdpAppender.m_client">
- <summary>
- The <see cref="T:System.Net.Sockets.UdpClient"/> instance that will be used for sending the
- logging events.
- </summary>
- </member>
- <member name="F:log4net.Appender.UdpAppender.m_encoding">
- <summary>
- The encoding to use for the packet.
- </summary>
- </member>
- <member name="P:log4net.Appender.UdpAppender.RemoteAddress">
- <summary>
- Gets or sets the IP address of the remote host or multicast group to which
- the underlying <see cref="T:System.Net.Sockets.UdpClient"/> should sent the logging event.
- </summary>
- <value>
- The IP address of the remote host or multicast group to which the logging event
- will be sent.
- </value>
- <remarks>
- <para>
- Multicast addresses are identified by IP class <b>D</b> addresses (in the range 224.0.0.0 to
- 239.255.255.255). Multicast packets can pass across different networks through routers, so
- it is possible to use multicasts in an Internet scenario as long as your network provider
- supports multicasting.
- </para>
- <para>
- Hosts that want to receive particular multicast messages must register their interest by joining
- the multicast group. Multicast messages are not sent to networks where no host has joined
- the multicast group. Class <b>D</b> IP addresses are used for multicast groups, to differentiate
- them from normal host addresses, allowing nodes to easily detect if a message is of interest.
- </para>
- <para>
- Static multicast addresses that are needed globally are assigned by IANA. A few examples are listed in the table below:
- </para>
- <para>
- <list type="table">
- <listheader>
- <term>IP Address</term>
- <description>Description</description>
- </listheader>
- <item>
- <term>224.0.0.1</term>
- <description>
- <para>
- Sends a message to all system on the subnet.
- </para>
- </description>
- </item>
- <item>
- <term>224.0.0.2</term>
- <description>
- <para>
- Sends a message to all routers on the subnet.
- </para>
- </description>
- </item>
- <item>
- <term>224.0.0.12</term>
- <description>
- <para>
- The DHCP server answers messages on the IP address 224.0.0.12, but only on a subnet.
- </para>
- </description>
- </item>
- </list>
- </para>
- <para>
- A complete list of actually reserved multicast addresses and their owners in the ranges
- defined by RFC 3171 can be found at the <A href="http://www.iana.org/assignments/multicast-addresses">IANA web site</A>.
- </para>
- <para>
- The address range 239.0.0.0 to 239.255.255.255 is reserved for administrative scope-relative
- addresses. These addresses can be reused with other local groups. Routers are typically
- configured with filters to prevent multicast traffic in this range from flowing outside
- of the local network.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Appender.UdpAppender.RemotePort">
- <summary>
- Gets or sets the TCP port number of the remote host or multicast group to which
- the underlying <see cref="T:System.Net.Sockets.UdpClient"/> should sent the logging event.
- </summary>
- <value>
- An integer value in the range <see cref="F:System.Net.IPEndPoint.MinPort"/> to <see cref="F:System.Net.IPEndPoint.MaxPort"/>
- indicating the TCP port number of the remote host or multicast group to which the logging event
- will be sent.
- </value>
- <remarks>
- The underlying <see cref="T:System.Net.Sockets.UdpClient"/> will send messages to this TCP port number
- on the remote host or multicast group.
- </remarks>
- <exception cref="T:System.ArgumentOutOfRangeException">The value specified is less than <see cref="F:System.Net.IPEndPoint.MinPort"/> or greater than <see cref="F:System.Net.IPEndPoint.MaxPort"/>.</exception>
- </member>
- <member name="P:log4net.Appender.UdpAppender.LocalPort">
- <summary>
- Gets or sets the TCP port number from which the underlying <see cref="T:System.Net.Sockets.UdpClient"/> will communicate.
- </summary>
- <value>
- An integer value in the range <see cref="F:System.Net.IPEndPoint.MinPort"/> to <see cref="F:System.Net.IPEndPoint.MaxPort"/>
- indicating the TCP port number from which the underlying <see cref="T:System.Net.Sockets.UdpClient"/> will communicate.
- </value>
- <remarks>
- <para>
- The underlying <see cref="T:System.Net.Sockets.UdpClient"/> will bind to this port for sending messages.
- </para>
- <para>
- Setting the value to 0 (the default) will cause the udp client not to bind to
- a local port.
- </para>
- </remarks>
- <exception cref="T:System.ArgumentOutOfRangeException">The value specified is less than <see cref="F:System.Net.IPEndPoint.MinPort"/> or greater than <see cref="F:System.Net.IPEndPoint.MaxPort"/>.</exception>
- </member>
- <member name="P:log4net.Appender.UdpAppender.Encoding">
- <summary>
- Gets or sets <see cref="P:log4net.Appender.UdpAppender.Encoding"/> used to write the packets.
- </summary>
- <value>
- The <see cref="P:log4net.Appender.UdpAppender.Encoding"/> used to write the packets.
- </value>
- <remarks>
- <para>
- The <see cref="P:log4net.Appender.UdpAppender.Encoding"/> used to write the packets.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Appender.UdpAppender.Client">
- <summary>
- Gets or sets the underlying <see cref="T:System.Net.Sockets.UdpClient"/>.
- </summary>
- <value>
- The underlying <see cref="T:System.Net.Sockets.UdpClient"/>.
- </value>
- <remarks>
- <see cref="T:log4net.Appender.UdpAppender"/> creates a <see cref="T:System.Net.Sockets.UdpClient"/> to send logging events
- over a network. Classes deriving from <see cref="T:log4net.Appender.UdpAppender"/> can use this
- property to get or set this <see cref="T:System.Net.Sockets.UdpClient"/>. Use the underlying <see cref="T:System.Net.Sockets.UdpClient"/>
- returned from <see cref="P:log4net.Appender.UdpAppender.Client"/> if you require access beyond that which
- <see cref="T:log4net.Appender.UdpAppender"/> provides.
- </remarks>
- </member>
- <member name="P:log4net.Appender.UdpAppender.RemoteEndPoint">
- <summary>
- Gets or sets the cached remote endpoint to which the logging events should be sent.
- </summary>
- <value>
- The cached remote endpoint to which the logging events will be sent.
- </value>
- <remarks>
- The <see cref="M:log4net.Appender.UdpAppender.ActivateOptions"/> method will initialize the remote endpoint
- with the values of the <see cref="P:log4net.Appender.UdpAppender.RemoteAddress"/> and <see cref="P:log4net.Appender.UdpAppender.RemotePort"/>
- properties.
- </remarks>
- </member>
- <member name="P:log4net.Appender.UdpAppender.RequiresLayout">
- <summary>
- This appender requires a <see cref="N:log4net.Layout"/> to be set.
- </summary>
- <value><c>true</c></value>
- <remarks>
- <para>
- This appender requires a <see cref="N:log4net.Layout"/> to be set.
- </para>
- </remarks>
- </member>
- <member name="F:log4net.Appender.RemoteSyslogAppender.DefaultSyslogPort">
- <summary>
- Syslog port 514
- </summary>
- </member>
- <member name="F:log4net.Appender.RemoteSyslogAppender.c_renderBufferSize">
- <summary>
- Initial buffer size
- </summary>
- </member>
- <member name="F:log4net.Appender.RemoteSyslogAppender.c_renderBufferMaxCapacity">
- <summary>
- Maximum buffer size before it is recycled
- </summary>
- </member>
- <member name="M:log4net.Appender.RemoteSyslogAppender.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:log4net.Appender.RemoteSyslogAppender"/> class.
- </summary>
- <remarks>
- This instance of the <see cref="T:log4net.Appender.RemoteSyslogAppender"/> class is set up to write
- to a remote syslog daemon.
- </remarks>
- </member>
- <member name="M:log4net.Appender.RemoteSyslogAppender.AddMapping(log4net.Appender.RemoteSyslogAppender.LevelSeverity)">
- <summary>
- Add a mapping of level to severity
- </summary>
- <param name="mapping">The mapping to add</param>
- <remarks>
- <para>
- Add a <see cref="T:log4net.Appender.RemoteSyslogAppender.LevelSeverity"/> mapping to this appender.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.RemoteSyslogAppender.Append(log4net.Core.LoggingEvent)">
- <summary>
- This method is called by the <see cref="M:AppenderSkeleton.DoAppend(LoggingEvent)"/> method.
- </summary>
- <param name="loggingEvent">The event to log.</param>
- <remarks>
- <para>
- Writes the event to a remote syslog daemon.
- </para>
- <para>
- The format of the output will depend on the appender's layout.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.RemoteSyslogAppender.ActivateOptions">
- <summary>
- Initialize the options for this appender
- </summary>
- <remarks>
- <para>
- Initialize the level to syslog severity mappings set on this appender.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.RemoteSyslogAppender.GetSeverity(log4net.Core.Level)">
- <summary>
- Translates a log4net level to a syslog severity.
- </summary>
- <param name="level">A log4net level.</param>
- <returns>A syslog severity.</returns>
- <remarks>
- <para>
- Translates a log4net level to a syslog severity.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.RemoteSyslogAppender.GeneratePriority(log4net.Appender.RemoteSyslogAppender.SyslogFacility,log4net.Appender.RemoteSyslogAppender.SyslogSeverity)">
- <summary>
- Generate a syslog priority.
- </summary>
- <param name="facility">The syslog facility.</param>
- <param name="severity">The syslog severity.</param>
- <returns>A syslog priority.</returns>
- <remarks>
- <para>
- Generate a syslog priority.
- </para>
- </remarks>
- </member>
- <member name="F:log4net.Appender.RemoteSyslogAppender.m_facility">
- <summary>
- The facility. The default facility is <see cref="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.User"/>.
- </summary>
- </member>
- <member name="F:log4net.Appender.RemoteSyslogAppender.m_identity">
- <summary>
- The message identity
- </summary>
- </member>
- <member name="F:log4net.Appender.RemoteSyslogAppender.m_levelMapping">
- <summary>
- Mapping from level object to syslog severity
- </summary>
- </member>
- <member name="P:log4net.Appender.RemoteSyslogAppender.Identity">
- <summary>
- Message identity
- </summary>
- <remarks>
- <para>
- An identifier is specified with each log message. This can be specified
- by setting the <see cref="P:log4net.Appender.RemoteSyslogAppender.Identity"/> property. The identity (also know
- as the tag) must not contain white space. The default value for the
- identity is the application name (from <see cref="P:log4net.Core.LoggingEvent.Domain"/>).
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Appender.RemoteSyslogAppender.Facility">
- <summary>
- Syslog facility
- </summary>
- <remarks>
- Set to one of the <see cref="T:log4net.Appender.RemoteSyslogAppender.SyslogFacility"/> values. The list of
- facilities is predefined and cannot be extended. The default value
- is <see cref="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.User"/>.
- </remarks>
- </member>
- <member name="T:log4net.Appender.RemoteSyslogAppender.SyslogSeverity">
- <summary>
- syslog severities
- </summary>
- <remarks>
- <para>
- The syslog severities.
- </para>
- </remarks>
- </member>
- <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogSeverity.Emergency">
- <summary>
- system is unusable
- </summary>
- </member>
- <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogSeverity.Alert">
- <summary>
- action must be taken immediately
- </summary>
- </member>
- <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogSeverity.Critical">
- <summary>
- critical conditions
- </summary>
- </member>
- <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogSeverity.Error">
- <summary>
- error conditions
- </summary>
- </member>
- <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogSeverity.Warning">
- <summary>
- warning conditions
- </summary>
- </member>
- <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogSeverity.Notice">
- <summary>
- normal but significant condition
- </summary>
- </member>
- <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogSeverity.Informational">
- <summary>
- informational
- </summary>
- </member>
- <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogSeverity.Debug">
- <summary>
- debug-level messages
- </summary>
- </member>
- <member name="T:log4net.Appender.RemoteSyslogAppender.SyslogFacility">
- <summary>
- syslog facilities
- </summary>
- <remarks>
- <para>
- The syslog facilities
- </para>
- </remarks>
- </member>
- <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Kernel">
- <summary>
- kernel messages
- </summary>
- </member>
- <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.User">
- <summary>
- random user-level messages
- </summary>
- </member>
- <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Mail">
- <summary>
- mail system
- </summary>
- </member>
- <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Daemons">
- <summary>
- system daemons
- </summary>
- </member>
- <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Authorization">
- <summary>
- security/authorization messages
- </summary>
- </member>
- <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Syslog">
- <summary>
- messages generated internally by syslogd
- </summary>
- </member>
- <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Printer">
- <summary>
- line printer subsystem
- </summary>
- </member>
- <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.News">
- <summary>
- network news subsystem
- </summary>
- </member>
- <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Uucp">
- <summary>
- UUCP subsystem
- </summary>
- </member>
- <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Clock">
- <summary>
- clock (cron/at) daemon
- </summary>
- </member>
- <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Authorization2">
- <summary>
- security/authorization messages (private)
- </summary>
- </member>
- <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Ftp">
- <summary>
- ftp daemon
- </summary>
- </member>
- <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Ntp">
- <summary>
- NTP subsystem
- </summary>
- </member>
- <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Audit">
- <summary>
- log audit
- </summary>
- </member>
- <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Alert">
- <summary>
- log alert
- </summary>
- </member>
- <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Clock2">
- <summary>
- clock daemon
- </summary>
- </member>
- <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Local0">
- <summary>
- reserved for local use
- </summary>
- </member>
- <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Local1">
- <summary>
- reserved for local use
- </summary>
- </member>
- <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Local2">
- <summary>
- reserved for local use
- </summary>
- </member>
- <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Local3">
- <summary>
- reserved for local use
- </summary>
- </member>
- <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Local4">
- <summary>
- reserved for local use
- </summary>
- </member>
- <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Local5">
- <summary>
- reserved for local use
- </summary>
- </member>
- <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Local6">
- <summary>
- reserved for local use
- </summary>
- </member>
- <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Local7">
- <summary>
- reserved for local use
- </summary>
- </member>
- <member name="T:log4net.Appender.RemoteSyslogAppender.LevelSeverity">
- <summary>
- A class to act as a mapping between the level that a logging call is made at and
- the syslog severity that is should be logged at.
- </summary>
- <remarks>
- <para>
- A class to act as a mapping between the level that a logging call is made at and
- the syslog severity that is should be logged at.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Appender.RemoteSyslogAppender.LevelSeverity.Severity">
- <summary>
- The mapped syslog severity for the specified level
- </summary>
- <remarks>
- <para>
- Required property.
- The mapped syslog severity for the specified level
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Appender.RemotingAppender">
- <summary>
- Delivers logging events to a remote logging sink.
- </summary>
- <remarks>
- <para>
- This Appender is designed to deliver events to a remote sink.
- That is any object that implements the <see cref="T:log4net.Appender.RemotingAppender.IRemoteLoggingSink"/>
- interface. It delivers the events using .NET remoting. The
- object to deliver events to is specified by setting the
- appenders <see cref="P:log4net.Appender.RemotingAppender.Sink"/> property.</para>
- <para>
- The RemotingAppender buffers events before sending them. This allows it to
- make more efficient use of the remoting infrastructure.</para>
- <para>
- Once the buffer is full the events are still not sent immediately.
- They are scheduled to be sent using a pool thread. The effect is that
- the send occurs asynchronously. This is very important for a
- number of non obvious reasons. The remoting infrastructure will
- flow thread local variables (stored in the <see cref="T:System.Runtime.Remoting.Messaging.CallContext"/>),
- if they are marked as <see cref="T:System.Runtime.Remoting.Messaging.ILogicalThreadAffinative"/>, across the
- remoting boundary. If the server is not contactable then
- the remoting infrastructure will clear the <see cref="T:System.Runtime.Remoting.Messaging.ILogicalThreadAffinative"/>
- objects from the <see cref="T:System.Runtime.Remoting.Messaging.CallContext"/>. To prevent a logging failure from
- having side effects on the calling application the remoting call must be made
- from a separate thread to the one used by the application. A <see cref="T:System.Threading.ThreadPool"/>
- thread is used for this. If no <see cref="T:System.Threading.ThreadPool"/> thread is available then
- the events will block in the thread pool manager until a thread is available.</para>
- <para>
- Because the events are sent asynchronously using pool threads it is possible to close
- this appender before all the queued events have been sent.
- When closing the appender attempts to wait until all the queued events have been sent, but
- this will timeout after 30 seconds regardless.</para>
- <para>
- If this appender is being closed because the <see cref="E:System.AppDomain.ProcessExit"/>
- event has fired it may not be possible to send all the queued events. During process
- exit the runtime limits the time that a <see cref="E:System.AppDomain.ProcessExit"/>
- event handler is allowed to run for. If the runtime terminates the threads before
- the queued events have been sent then they will be lost. To ensure that all events
- are sent the appender must be closed before the application exits. See
- <see cref="M:log4net.Core.LoggerManager.Shutdown"/> for details on how to shutdown
- log4net programmatically.</para>
- </remarks>
- <seealso cref="T:log4net.Appender.RemotingAppender.IRemoteLoggingSink"/>
- <author>Nicko Cadell</author>
- <author>Gert Driesen</author>
- <author>Daniel Cazzulino</author>
- </member>
- <member name="M:log4net.Appender.RemotingAppender.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:log4net.Appender.RemotingAppender"/> class.
- </summary>
- <remarks>
- <para>
- Default constructor.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.RemotingAppender.ActivateOptions">
- <summary>
- Initialize the appender based on the options set
- </summary>
- <remarks>
- <para>
- This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
- activation scheme. The <see cref="M:log4net.Appender.RemotingAppender.ActivateOptions"/> method must
- be called on this object after the configuration properties have
- been set. Until <see cref="M:log4net.Appender.RemotingAppender.ActivateOptions"/> is called this
- object is in an undefined state and must not be used.
- </para>
- <para>
- If any of the configuration properties are modified then
- <see cref="M:log4net.Appender.RemotingAppender.ActivateOptions"/> must be called again.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.RemotingAppender.SendBuffer(log4net.Core.LoggingEvent[])">
- <summary>
- Send the contents of the buffer to the remote sink.
- </summary>
- <remarks>
- The events are not sent immediately. They are scheduled to be sent
- using a pool thread. The effect is that the send occurs asynchronously.
- This is very important for a number of non obvious reasons. The remoting
- infrastructure will flow thread local variables (stored in the <see cref="T:System.Runtime.Remoting.Messaging.CallContext"/>),
- if they are marked as <see cref="T:System.Runtime.Remoting.Messaging.ILogicalThreadAffinative"/>, across the
- remoting boundary. If the server is not contactable then
- the remoting infrastructure will clear the <see cref="T:System.Runtime.Remoting.Messaging.ILogicalThreadAffinative"/>
- objects from the <see cref="T:System.Runtime.Remoting.Messaging.CallContext"/>. To prevent a logging failure from
- having side effects on the calling application the remoting call must be made
- from a separate thread to the one used by the application. A <see cref="T:System.Threading.ThreadPool"/>
- thread is used for this. If no <see cref="T:System.Threading.ThreadPool"/> thread is available then
- the events will block in the thread pool manager until a thread is available.
- </remarks>
- <param name="events">The events to send.</param>
- </member>
- <member name="M:log4net.Appender.RemotingAppender.OnClose">
- <summary>
- Override base class close.
- </summary>
- <remarks>
- <para>
- This method waits while there are queued work items. The events are
- sent asynchronously using <see cref="T:System.Threading.ThreadPool"/> work items. These items
- will be sent once a thread pool thread is available to send them, therefore
- it is possible to close the appender before all the queued events have been
- sent.</para>
- <para>
- This method attempts to wait until all the queued events have been sent, but this
- method will timeout after 30 seconds regardless.</para>
- <para>
- If the appender is being closed because the <see cref="E:System.AppDomain.ProcessExit"/>
- event has fired it may not be possible to send all the queued events. During process
- exit the runtime limits the time that a <see cref="E:System.AppDomain.ProcessExit"/>
- event handler is allowed to run for.</para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.RemotingAppender.BeginAsyncSend">
- <summary>
- A work item is being queued into the thread pool
- </summary>
- </member>
- <member name="M:log4net.Appender.RemotingAppender.EndAsyncSend">
- <summary>
- A work item from the thread pool has completed
- </summary>
- </member>
- <member name="M:log4net.Appender.RemotingAppender.SendBufferCallback(System.Object)">
- <summary>
- Send the contents of the buffer to the remote sink.
- </summary>
- <remarks>
- This method is designed to be used with the <see cref="T:System.Threading.ThreadPool"/>.
- This method expects to be passed an array of <see cref="T:log4net.Core.LoggingEvent"/>
- objects in the state param.
- </remarks>
- <param name="state">the logging events to send</param>
- </member>
- <member name="F:log4net.Appender.RemotingAppender.m_sinkUrl">
- <summary>
- The URL of the remote sink.
- </summary>
- </member>
- <member name="F:log4net.Appender.RemotingAppender.m_sinkObj">
- <summary>
- The local proxy (.NET remoting) for the remote logging sink.
- </summary>
- </member>
- <member name="F:log4net.Appender.RemotingAppender.m_queuedCallbackCount">
- <summary>
- The number of queued callbacks currently waiting or executing
- </summary>
- </member>
- <member name="F:log4net.Appender.RemotingAppender.m_workQueueEmptyEvent">
- <summary>
- Event used to signal when there are no queued work items
- </summary>
- <remarks>
- This event is set when there are no queued work items. In this
- state it is safe to close the appender.
- </remarks>
- </member>
- <member name="P:log4net.Appender.RemotingAppender.Sink">
- <summary>
- Gets or sets the URL of the well-known object that will accept
- the logging events.
- </summary>
- <value>
- The well-known URL of the remote sink.
- </value>
- <remarks>
- <para>
- The URL of the remoting sink that will accept logging events.
- The sink must implement the <see cref="T:log4net.Appender.RemotingAppender.IRemoteLoggingSink"/>
- interface.
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Appender.RemotingAppender.IRemoteLoggingSink">
- <summary>
- Interface used to deliver <see cref="T:log4net.Core.LoggingEvent"/> objects to a remote sink.
- </summary>
- <remarks>
- This interface must be implemented by a remoting sink
- if the <see cref="T:log4net.Appender.RemotingAppender"/> is to be used
- to deliver logging events to the sink.
- </remarks>
- </member>
- <member name="M:log4net.Appender.RemotingAppender.IRemoteLoggingSink.LogEvents(log4net.Core.LoggingEvent[])">
- <summary>
- Delivers logging events to the remote sink
- </summary>
- <param name="events">Array of events to log.</param>
- <remarks>
- <para>
- Delivers logging events to the remote sink
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Appender.RollingFileAppender">
- <summary>
- Appender that rolls log files based on size or date or both.
- </summary>
- <remarks>
- <para>
- RollingFileAppender can roll log files based on size or date or both
- depending on the setting of the <see cref="P:log4net.Appender.RollingFileAppender.RollingStyle"/> property.
- When set to <see cref="F:log4net.Appender.RollingFileAppender.RollingMode.Size"/> the log file will be rolled
- once its size exceeds the <see cref="P:log4net.Appender.RollingFileAppender.MaximumFileSize"/>.
- When set to <see cref="F:log4net.Appender.RollingFileAppender.RollingMode.Date"/> the log file will be rolled
- once the date boundary specified in the <see cref="P:log4net.Appender.RollingFileAppender.DatePattern"/> property
- is crossed.
- When set to <see cref="F:log4net.Appender.RollingFileAppender.RollingMode.Composite"/> the log file will be
- rolled once the date boundary specified in the <see cref="P:log4net.Appender.RollingFileAppender.DatePattern"/> property
- is crossed, but within a date boundary the file will also be rolled
- once its size exceeds the <see cref="P:log4net.Appender.RollingFileAppender.MaximumFileSize"/>.
- When set to <see cref="F:log4net.Appender.RollingFileAppender.RollingMode.Once"/> the log file will be rolled when
- the appender is configured. This effectively means that the log file can be
- rolled once per program execution.
- </para>
- <para>
- A of few additional optional features have been added:
- <list type="bullet">
- <item>Attach date pattern for current log file <see cref="P:log4net.Appender.RollingFileAppender.StaticLogFileName"/></item>
- <item>Backup number increments for newer files <see cref="P:log4net.Appender.RollingFileAppender.CountDirection"/></item>
- <item>Infinite number of backups by file size <see cref="P:log4net.Appender.RollingFileAppender.MaxSizeRollBackups"/></item>
- </list>
- </para>
-
- <note>
- <para>
- For large or infinite numbers of backup files a <see cref="P:log4net.Appender.RollingFileAppender.CountDirection"/>
- greater than zero is highly recommended, otherwise all the backup files need
- to be renamed each time a new backup is created.
- </para>
- <para>
- When Date/Time based rolling is used setting <see cref="P:log4net.Appender.RollingFileAppender.StaticLogFileName"/>
- to <see langword="true"/> will reduce the number of file renamings to few or none.
- </para>
- </note>
-
- <note type="caution">
- <para>
- Changing <see cref="P:log4net.Appender.RollingFileAppender.StaticLogFileName"/> or <see cref="P:log4net.Appender.RollingFileAppender.CountDirection"/> without clearing
- the log file directory of backup files will cause unexpected and unwanted side effects.
- </para>
- </note>
-
- <para>
- If Date/Time based rolling is enabled this appender will attempt to roll existing files
- in the directory without a Date/Time tag based on the last write date of the base log file.
- The appender only rolls the log file when a message is logged. If Date/Time based rolling
- is enabled then the appender will not roll the log file at the Date/Time boundary but
- at the point when the next message is logged after the boundary has been crossed.
- </para>
-
- <para>
- The <see cref="T:log4net.Appender.RollingFileAppender"/> extends the <see cref="T:log4net.Appender.FileAppender"/> and
- has the same behavior when opening the log file.
- The appender will first try to open the file for writing when <see cref="M:log4net.Appender.RollingFileAppender.ActivateOptions"/>
- is called. This will typically be during configuration.
- If the file cannot be opened for writing the appender will attempt
- to open the file again each time a message is logged to the appender.
- If the file cannot be opened for writing when a message is logged then
- the message will be discarded by this appender.
- </para>
- <para>
- When rolling a backup file necessitates deleting an older backup file the
- file to be deleted is moved to a temporary name before being deleted.
- </para>
-
- <note type="caution">
- <para>
- A maximum number of backup files when rolling on date/time boundaries is not supported.
- </para>
- </note>
- </remarks>
- <author>Nicko Cadell</author>
- <author>Gert Driesen</author>
- <author>Aspi Havewala</author>
- <author>Douglas de la Torre</author>
- <author>Edward Smit</author>
- </member>
- <member name="M:log4net.Appender.RollingFileAppender.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:log4net.Appender.RollingFileAppender"/> class.
- </summary>
- <remarks>
- <para>
- Default constructor.
- </para>
- </remarks>
- </member>
- <member name="F:log4net.Appender.RollingFileAppender.declaringType">
- <summary>
- The fully qualified type of the RollingFileAppender class.
- </summary>
- <remarks>
- Used by the internal logger to record the Type of the
- log message.
- </remarks>
- </member>
- <member name="M:log4net.Appender.RollingFileAppender.SetQWForFiles(System.IO.TextWriter)">
- <summary>
- Sets the quiet writer being used.
- </summary>
- <remarks>
- This method can be overridden by sub classes.
- </remarks>
- <param name="writer">the writer to set</param>
- </member>
- <member name="M:log4net.Appender.RollingFileAppender.Append(log4net.Core.LoggingEvent)">
- <summary>
- Write out a logging event.
- </summary>
- <param name="loggingEvent">the event to write to file.</param>
- <remarks>
- <para>
- Handles append time behavior for RollingFileAppender. This checks
- if a roll over either by date (checked first) or time (checked second)
- is need and then appends to the file last.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.RollingFileAppender.Append(log4net.Core.LoggingEvent[])">
- <summary>
- Write out an array of logging events.
- </summary>
- <param name="loggingEvents">the events to write to file.</param>
- <remarks>
- <para>
- Handles append time behavior for RollingFileAppender. This checks
- if a roll over either by date (checked first) or time (checked second)
- is need and then appends to the file last.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.RollingFileAppender.AdjustFileBeforeAppend">
- <summary>
- Performs any required rolling before outputting the next event
- </summary>
- <remarks>
- <para>
- Handles append time behavior for RollingFileAppender. This checks
- if a roll over either by date (checked first) or time (checked second)
- is need and then appends to the file last.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.RollingFileAppender.OpenFile(System.String,System.Boolean)">
- <summary>
- Creates and opens the file for logging. If <see cref="P:log4net.Appender.RollingFileAppender.StaticLogFileName"/>
- is false then the fully qualified name is determined and used.
- </summary>
- <param name="fileName">the name of the file to open</param>
- <param name="append">true to append to existing file</param>
- <remarks>
- <para>This method will ensure that the directory structure
- for the <paramref name="fileName"/> specified exists.</para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.RollingFileAppender.GetNextOutputFileName(System.String)">
- <summary>
- Get the current output file name
- </summary>
- <param name="fileName">the base file name</param>
- <returns>the output file name</returns>
- <remarks>
- The output file name is based on the base fileName specified.
- If <see cref="P:log4net.Appender.RollingFileAppender.StaticLogFileName"/> is set then the output
- file name is the same as the base file passed in. Otherwise
- the output file depends on the date pattern, on the count
- direction or both.
- </remarks>
- </member>
- <member name="M:log4net.Appender.RollingFileAppender.DetermineCurSizeRollBackups">
- <summary>
- Determines curSizeRollBackups (only within the current roll point)
- </summary>
- </member>
- <member name="M:log4net.Appender.RollingFileAppender.GetWildcardPatternForFile(System.String)">
- <summary>
- Generates a wildcard pattern that can be used to find all files
- that are similar to the base file name.
- </summary>
- <param name="baseFileName"></param>
- <returns></returns>
- </member>
- <member name="M:log4net.Appender.RollingFileAppender.GetExistingFiles(System.String)">
- <summary>
- Builds a list of filenames for all files matching the base filename plus a file
- pattern.
- </summary>
- <param name="baseFilePath"></param>
- <returns></returns>
- </member>
- <member name="M:log4net.Appender.RollingFileAppender.RollOverIfDateBoundaryCrossing">
- <summary>
- Initiates a roll over if needed for crossing a date boundary since the last run.
- </summary>
- </member>
- <member name="M:log4net.Appender.RollingFileAppender.ExistingInit">
- <summary>
- Initializes based on existing conditions at time of <see cref="M:log4net.Appender.RollingFileAppender.ActivateOptions"/>.
- </summary>
- <remarks>
- <para>
- Initializes based on existing conditions at time of <see cref="M:log4net.Appender.RollingFileAppender.ActivateOptions"/>.
- The following is done
- <list type="bullet">
- <item>determine curSizeRollBackups (only within the current roll point)</item>
- <item>initiates a roll over if needed for crossing a date boundary since the last run.</item>
- </list>
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.RollingFileAppender.InitializeFromOneFile(System.String,System.String)">
- <summary>
- Does the work of bumping the 'current' file counter higher
- to the highest count when an incremental file name is seen.
- The highest count is either the first file (when count direction
- is greater than 0) or the last file (when count direction less than 0).
- In either case, we want to know the highest count that is present.
- </summary>
- <param name="baseFile"></param>
- <param name="curFileName"></param>
- </member>
- <member name="M:log4net.Appender.RollingFileAppender.GetBackUpIndex(System.String)">
- <summary>
- Attempts to extract a number from the end of the file name that indicates
- the number of the times the file has been rolled over.
- </summary>
- <remarks>
- Certain date pattern extensions like yyyyMMdd will be parsed as valid backup indexes.
- </remarks>
- <param name="curFileName"></param>
- <returns></returns>
- </member>
- <member name="M:log4net.Appender.RollingFileAppender.InitializeRollBackups(System.String,System.Collections.ArrayList)">
- <summary>
- Takes a list of files and a base file name, and looks for
- 'incremented' versions of the base file. Bumps the max
- count up to the highest count seen.
- </summary>
- <param name="baseFile"></param>
- <param name="arrayFiles"></param>
- </member>
- <member name="M:log4net.Appender.RollingFileAppender.ComputeCheckPeriod(System.String)">
- <summary>
- Calculates the RollPoint for the datePattern supplied.
- </summary>
- <param name="datePattern">the date pattern to calculate the check period for</param>
- <returns>The RollPoint that is most accurate for the date pattern supplied</returns>
- <remarks>
- Essentially the date pattern is examined to determine what the
- most suitable roll point is. The roll point chosen is the roll point
- with the smallest period that can be detected using the date pattern
- supplied. i.e. if the date pattern only outputs the year, month, day
- and hour then the smallest roll point that can be detected would be
- and hourly roll point as minutes could not be detected.
- </remarks>
- </member>
- <member name="M:log4net.Appender.RollingFileAppender.ActivateOptions">
- <summary>
- Initialize the appender based on the options set
- </summary>
- <remarks>
- <para>
- This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
- activation scheme. The <see cref="M:log4net.Appender.RollingFileAppender.ActivateOptions"/> method must
- be called on this object after the configuration properties have
- been set. Until <see cref="M:log4net.Appender.RollingFileAppender.ActivateOptions"/> is called this
- object is in an undefined state and must not be used.
- </para>
- <para>
- If any of the configuration properties are modified then
- <see cref="M:log4net.Appender.RollingFileAppender.ActivateOptions"/> must be called again.
- </para>
- <para>
- Sets initial conditions including date/time roll over information, first check,
- scheduledFilename, and calls <see cref="M:log4net.Appender.RollingFileAppender.ExistingInit"/> to initialize
- the current number of backups.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.RollingFileAppender.CombinePath(System.String,System.String)">
- <summary>
-
- </summary>
- <param name="path1"></param>
- <param name="path2">.1, .2, .3, etc.</param>
- <returns></returns>
- </member>
- <member name="M:log4net.Appender.RollingFileAppender.RollOverTime(System.Boolean)">
- <summary>
- Rollover the file(s) to date/time tagged file(s).
- </summary>
- <param name="fileIsOpen">set to true if the file to be rolled is currently open</param>
- <remarks>
- <para>
- Rollover the file(s) to date/time tagged file(s).
- Resets curSizeRollBackups.
- If fileIsOpen is set then the new file is opened (through SafeOpenFile).
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.RollingFileAppender.RollFile(System.String,System.String)">
- <summary>
- Renames file <paramref name="fromFile"/> to file <paramref name="toFile"/>.
- </summary>
- <param name="fromFile">Name of existing file to roll.</param>
- <param name="toFile">New name for file.</param>
- <remarks>
- <para>
- Renames file <paramref name="fromFile"/> to file <paramref name="toFile"/>. It
- also checks for existence of target file and deletes if it does.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.RollingFileAppender.FileExists(System.String)">
- <summary>
- Test if a file exists at a specified path
- </summary>
- <param name="path">the path to the file</param>
- <returns>true if the file exists</returns>
- <remarks>
- <para>
- Test if a file exists at a specified path
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.RollingFileAppender.DeleteFile(System.String)">
- <summary>
- Deletes the specified file if it exists.
- </summary>
- <param name="fileName">The file to delete.</param>
- <remarks>
- <para>
- Delete a file if is exists.
- The file is first moved to a new filename then deleted.
- This allows the file to be removed even when it cannot
- be deleted, but it still can be moved.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.RollingFileAppender.RollOverSize">
- <summary>
- Implements file roll base on file size.
- </summary>
- <remarks>
- <para>
- If the maximum number of size based backups is reached
- (<c>curSizeRollBackups == maxSizeRollBackups</c>) then the oldest
- file is deleted -- its index determined by the sign of countDirection.
- If <c>countDirection</c> < 0, then files
- {<c>File.1</c>, ..., <c>File.curSizeRollBackups -1</c>}
- are renamed to {<c>File.2</c>, ...,
- <c>File.curSizeRollBackups</c>}. Moreover, <c>File</c> is
- renamed <c>File.1</c> and closed.
- </para>
- <para>
- A new file is created to receive further log output.
- </para>
- <para>
- If <c>maxSizeRollBackups</c> is equal to zero, then the
- <c>File</c> is truncated with no backup files created.
- </para>
- <para>
- If <c>maxSizeRollBackups</c> < 0, then <c>File</c> is
- renamed if needed and no files are deleted.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.RollingFileAppender.RollOverRenameFiles(System.String)">
- <summary>
- Implements file roll.
- </summary>
- <param name="baseFileName">the base name to rename</param>
- <remarks>
- <para>
- If the maximum number of size based backups is reached
- (<c>curSizeRollBackups == maxSizeRollBackups</c>) then the oldest
- file is deleted -- its index determined by the sign of countDirection.
- If <c>countDirection</c> < 0, then files
- {<c>File.1</c>, ..., <c>File.curSizeRollBackups -1</c>}
- are renamed to {<c>File.2</c>, ...,
- <c>File.curSizeRollBackups</c>}.
- </para>
- <para>
- If <c>maxSizeRollBackups</c> is equal to zero, then the
- <c>File</c> is truncated with no backup files created.
- </para>
- <para>
- If <c>maxSizeRollBackups</c> < 0, then <c>File</c> is
- renamed if needed and no files are deleted.
- </para>
- <para>
- This is called by <see cref="M:log4net.Appender.RollingFileAppender.RollOverSize"/> to rename the files.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.RollingFileAppender.NextCheckDate(System.DateTime,log4net.Appender.RollingFileAppender.RollPoint)">
- <summary>
- Get the start time of the next window for the current rollpoint
- </summary>
- <param name="currentDateTime">the current date</param>
- <param name="rollPoint">the type of roll point we are working with</param>
- <returns>the start time for the next roll point an interval after the currentDateTime date</returns>
- <remarks>
- <para>
- Returns the date of the next roll point after the currentDateTime date passed to the method.
- </para>
- <para>
- The basic strategy is to subtract the time parts that are less significant
- than the rollpoint from the current time. This should roll the time back to
- the start of the time window for the current rollpoint. Then we add 1 window
- worth of time and get the start time of the next window for the rollpoint.
- </para>
- </remarks>
- </member>
- <member name="F:log4net.Appender.RollingFileAppender.m_dateTime">
- <summary>
- This object supplies the current date/time. Allows test code to plug in
- a method to control this class when testing date/time based rolling. The default
- implementation uses the underlying value of DateTime.Now.
- </summary>
- </member>
- <member name="F:log4net.Appender.RollingFileAppender.m_datePattern">
- <summary>
- The date pattern. By default, the pattern is set to <c>".yyyy-MM-dd"</c>
- meaning daily rollover.
- </summary>
- </member>
- <member name="F:log4net.Appender.RollingFileAppender.m_scheduledFilename">
- <summary>
- The actual formatted filename that is currently being written to
- or will be the file transferred to on roll over
- (based on staticLogFileName).
- </summary>
- </member>
- <member name="F:log4net.Appender.RollingFileAppender.m_nextCheck">
- <summary>
- The timestamp when we shall next recompute the filename.
- </summary>
- </member>
- <member name="F:log4net.Appender.RollingFileAppender.m_now">
- <summary>
- Holds date of last roll over
- </summary>
- </member>
- <member name="F:log4net.Appender.RollingFileAppender.m_rollPoint">
- <summary>
- The type of rolling done
- </summary>
- </member>
- <member name="F:log4net.Appender.RollingFileAppender.m_maxFileSize">
- <summary>
- The default maximum file size is 10MB
- </summary>
- </member>
- <member name="F:log4net.Appender.RollingFileAppender.m_maxSizeRollBackups">
- <summary>
- There is zero backup files by default
- </summary>
- </member>
- <member name="F:log4net.Appender.RollingFileAppender.m_curSizeRollBackups">
- <summary>
- How many sized based backups have been made so far
- </summary>
- </member>
- <member name="F:log4net.Appender.RollingFileAppender.m_countDirection">
- <summary>
- The rolling file count direction.
- </summary>
- </member>
- <member name="F:log4net.Appender.RollingFileAppender.m_rollingStyle">
- <summary>
- The rolling mode used in this appender.
- </summary>
- </member>
- <member name="F:log4net.Appender.RollingFileAppender.m_rollDate">
- <summary>
- Cache flag set if we are rolling by date.
- </summary>
- </member>
- <member name="F:log4net.Appender.RollingFileAppender.m_rollSize">
- <summary>
- Cache flag set if we are rolling by size.
- </summary>
- </member>
- <member name="F:log4net.Appender.RollingFileAppender.m_staticLogFileName">
- <summary>
- Value indicating whether to always log to the same file.
- </summary>
- </member>
- <member name="F:log4net.Appender.RollingFileAppender.m_preserveLogFileNameExtension">
- <summary>
- Value indicating whether to preserve the file name extension when rolling.
- </summary>
- </member>
- <member name="F:log4net.Appender.RollingFileAppender.m_baseFileName">
- <summary>
- FileName provided in configuration. Used for rolling properly
- </summary>
- </member>
- <member name="F:log4net.Appender.RollingFileAppender.s_date1970">
- <summary>
- The 1st of January 1970 in UTC
- </summary>
- </member>
- <member name="P:log4net.Appender.RollingFileAppender.DateTimeStrategy">
- <summary>
- Gets or sets the strategy for determining the current date and time. The default
- implementation is to use LocalDateTime which internally calls through to DateTime.Now.
- DateTime.UtcNow may be used on frameworks newer than .NET 1.0 by specifying
- <see cref="T:log4net.Appender.RollingFileAppender.UniversalDateTime"/>.
- </summary>
- <value>
- An implementation of the <see cref="T:log4net.Appender.RollingFileAppender.IDateTime"/> interface which returns the current date and time.
- </value>
- <remarks>
- <para>
- Gets or sets the <see cref="T:log4net.Appender.RollingFileAppender.IDateTime"/> used to return the current date and time.
- </para>
- <para>
- There are two built strategies for determining the current date and time,
- <see cref="T:log4net.Appender.RollingFileAppender.LocalDateTime"/>
- and <see cref="T:log4net.Appender.RollingFileAppender.UniversalDateTime"/>.
- </para>
- <para>
- The default strategy is <see cref="T:log4net.Appender.RollingFileAppender.LocalDateTime"/>.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Appender.RollingFileAppender.DatePattern">
- <summary>
- Gets or sets the date pattern to be used for generating file names
- when rolling over on date.
- </summary>
- <value>
- The date pattern to be used for generating file names when rolling
- over on date.
- </value>
- <remarks>
- <para>
- Takes a string in the same format as expected by
- <see cref="T:log4net.DateFormatter.SimpleDateFormatter"/>.
- </para>
- <para>
- This property determines the rollover schedule when rolling over
- on date.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Appender.RollingFileAppender.MaxSizeRollBackups">
- <summary>
- Gets or sets the maximum number of backup files that are kept before
- the oldest is erased.
- </summary>
- <value>
- The maximum number of backup files that are kept before the oldest is
- erased.
- </value>
- <remarks>
- <para>
- If set to zero, then there will be no backup files and the log file
- will be truncated when it reaches <see cref="P:log4net.Appender.RollingFileAppender.MaxFileSize"/>.
- </para>
- <para>
- If a negative number is supplied then no deletions will be made. Note
- that this could result in very slow performance as a large number of
- files are rolled over unless <see cref="P:log4net.Appender.RollingFileAppender.CountDirection"/> is used.
- </para>
- <para>
- The maximum applies to <b>each</b> time based group of files and
- <b>not</b> the total.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Appender.RollingFileAppender.MaxFileSize">
- <summary>
- Gets or sets the maximum size that the output file is allowed to reach
- before being rolled over to backup files.
- </summary>
- <value>
- The maximum size in bytes that the output file is allowed to reach before being
- rolled over to backup files.
- </value>
- <remarks>
- <para>
- This property is equivalent to <see cref="P:log4net.Appender.RollingFileAppender.MaximumFileSize"/> except
- that it is required for differentiating the setter taking a
- <see cref="T:System.Int64"/> argument from the setter taking a <see cref="T:System.String"/>
- argument.
- </para>
- <para>
- The default maximum file size is 10MB (10*1024*1024).
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Appender.RollingFileAppender.MaximumFileSize">
- <summary>
- Gets or sets the maximum size that the output file is allowed to reach
- before being rolled over to backup files.
- </summary>
- <value>
- The maximum size that the output file is allowed to reach before being
- rolled over to backup files.
- </value>
- <remarks>
- <para>
- This property allows you to specify the maximum size with the
- suffixes "KB", "MB" or "GB" so that the size is interpreted being
- expressed respectively in kilobytes, megabytes or gigabytes.
- </para>
- <para>
- For example, the value "10KB" will be interpreted as 10240 bytes.
- </para>
- <para>
- The default maximum file size is 10MB.
- </para>
- <para>
- If you have the option to set the maximum file size programmatically
- consider using the <see cref="P:log4net.Appender.RollingFileAppender.MaxFileSize"/> property instead as this
- allows you to set the size in bytes as a <see cref="T:System.Int64"/>.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Appender.RollingFileAppender.CountDirection">
- <summary>
- Gets or sets the rolling file count direction.
- </summary>
- <value>
- The rolling file count direction.
- </value>
- <remarks>
- <para>
- Indicates if the current file is the lowest numbered file or the
- highest numbered file.
- </para>
- <para>
- By default newer files have lower numbers (<see cref="P:log4net.Appender.RollingFileAppender.CountDirection"/> < 0),
- i.e. log.1 is most recent, log.5 is the 5th backup, etc...
- </para>
- <para>
- <see cref="P:log4net.Appender.RollingFileAppender.CountDirection"/> >= 0 does the opposite i.e.
- log.1 is the first backup made, log.5 is the 5th backup made, etc.
- For infinite backups use <see cref="P:log4net.Appender.RollingFileAppender.CountDirection"/> >= 0 to reduce
- rollover costs.
- </para>
- <para>The default file count direction is -1.</para>
- </remarks>
- </member>
- <member name="P:log4net.Appender.RollingFileAppender.RollingStyle">
- <summary>
- Gets or sets the rolling style.
- </summary>
- <value>The rolling style.</value>
- <remarks>
- <para>
- The default rolling style is <see cref="F:log4net.Appender.RollingFileAppender.RollingMode.Composite"/>.
- </para>
- <para>
- When set to <see cref="F:log4net.Appender.RollingFileAppender.RollingMode.Once"/> this appender's
- <see cref="P:log4net.Appender.FileAppender.AppendToFile"/> property is set to <c>false</c>, otherwise
- the appender would append to a single file rather than rolling
- the file each time it is opened.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Appender.RollingFileAppender.PreserveLogFileNameExtension">
- <summary>
- Gets or sets a value indicating whether to preserve the file name extension when rolling.
- </summary>
- <value>
- <c>true</c> if the file name extension should be preserved.
- </value>
- <remarks>
- <para>
- By default file.log is rolled to file.log.yyyy-MM-dd or file.log.curSizeRollBackup.
- However, under Windows the new file name will loose any program associations as the
- extension is changed. Optionally file.log can be renamed to file.yyyy-MM-dd.log or
- file.curSizeRollBackup.log to maintain any program associations.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Appender.RollingFileAppender.StaticLogFileName">
- <summary>
- Gets or sets a value indicating whether to always log to
- the same file.
- </summary>
- <value>
- <c>true</c> if always should be logged to the same file, otherwise <c>false</c>.
- </value>
- <remarks>
- <para>
- By default file.log is always the current file. Optionally
- file.log.yyyy-mm-dd for current formatted datePattern can by the currently
- logging file (or file.log.curSizeRollBackup or even
- file.log.yyyy-mm-dd.curSizeRollBackup).
- </para>
- <para>
- This will make time based rollovers with a large number of backups
- much faster as the appender it won't have to rename all the backups!
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Appender.RollingFileAppender.RollingMode">
- <summary>
- Style of rolling to use
- </summary>
- <remarks>
- <para>
- Style of rolling to use
- </para>
- </remarks>
- </member>
- <member name="F:log4net.Appender.RollingFileAppender.RollingMode.Once">
- <summary>
- Roll files once per program execution
- </summary>
- <remarks>
- <para>
- Roll files once per program execution.
- Well really once each time this appender is
- configured.
- </para>
- <para>
- Setting this option also sets <c>AppendToFile</c> to
- <c>false</c> on the <c>RollingFileAppender</c>, otherwise
- this appender would just be a normal file appender.
- </para>
- </remarks>
- </member>
- <member name="F:log4net.Appender.RollingFileAppender.RollingMode.Size">
- <summary>
- Roll files based only on the size of the file
- </summary>
- </member>
- <member name="F:log4net.Appender.RollingFileAppender.RollingMode.Date">
- <summary>
- Roll files based only on the date
- </summary>
- </member>
- <member name="F:log4net.Appender.RollingFileAppender.RollingMode.Composite">
- <summary>
- Roll files based on both the size and date of the file
- </summary>
- </member>
- <member name="T:log4net.Appender.RollingFileAppender.RollPoint">
- <summary>
- The code assumes that the following 'time' constants are in a increasing sequence.
- </summary>
- <remarks>
- <para>
- The code assumes that the following 'time' constants are in a increasing sequence.
- </para>
- </remarks>
- </member>
- <member name="F:log4net.Appender.RollingFileAppender.RollPoint.InvalidRollPoint">
- <summary>
- Roll the log not based on the date
- </summary>
- </member>
- <member name="F:log4net.Appender.RollingFileAppender.RollPoint.TopOfMinute">
- <summary>
- Roll the log for each minute
- </summary>
- </member>
- <member name="F:log4net.Appender.RollingFileAppender.RollPoint.TopOfHour">
- <summary>
- Roll the log for each hour
- </summary>
- </member>
- <member name="F:log4net.Appender.RollingFileAppender.RollPoint.HalfDay">
- <summary>
- Roll the log twice a day (midday and midnight)
- </summary>
- </member>
- <member name="F:log4net.Appender.RollingFileAppender.RollPoint.TopOfDay">
- <summary>
- Roll the log each day (midnight)
- </summary>
- </member>
- <member name="F:log4net.Appender.RollingFileAppender.RollPoint.TopOfWeek">
- <summary>
- Roll the log each week
- </summary>
- </member>
- <member name="F:log4net.Appender.RollingFileAppender.RollPoint.TopOfMonth">
- <summary>
- Roll the log each month
- </summary>
- </member>
- <member name="T:log4net.Appender.RollingFileAppender.IDateTime">
- <summary>
- This interface is used to supply Date/Time information to the <see cref="T:log4net.Appender.RollingFileAppender"/>.
- </summary>
- <remarks>
- This interface is used to supply Date/Time information to the <see cref="T:log4net.Appender.RollingFileAppender"/>.
- Used primarily to allow test classes to plug themselves in so they can
- supply test date/times.
- </remarks>
- </member>
- <member name="P:log4net.Appender.RollingFileAppender.IDateTime.Now">
- <summary>
- Gets the <i>current</i> time.
- </summary>
- <value>The <i>current</i> time.</value>
- <remarks>
- <para>
- Gets the <i>current</i> time.
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Appender.RollingFileAppender.LocalDateTime">
- <summary>
- Default implementation of <see cref="T:log4net.Appender.RollingFileAppender.IDateTime"/> that returns the current time.
- </summary>
- </member>
- <member name="P:log4net.Appender.RollingFileAppender.LocalDateTime.Now">
- <summary>
- Gets the <b>current</b> time.
- </summary>
- <value>The <b>current</b> time.</value>
- <remarks>
- <para>
- Gets the <b>current</b> time.
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Appender.RollingFileAppender.UniversalDateTime">
- <summary>
- Implementation of <see cref="T:log4net.Appender.RollingFileAppender.IDateTime"/> that returns the current time as the coordinated universal time (UTC).
- </summary>
- </member>
- <member name="P:log4net.Appender.RollingFileAppender.UniversalDateTime.Now">
- <summary>
- Gets the <b>current</b> time.
- </summary>
- <value>The <b>current</b> time.</value>
- <remarks>
- <para>
- Gets the <b>current</b> time.
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Appender.SmtpAppender">
- <summary>
- Send an e-mail when a specific logging event occurs, typically on errors
- or fatal errors.
- </summary>
- <remarks>
- <para>
- The number of logging events delivered in this e-mail depend on
- the value of <see cref="P:log4net.Appender.BufferingAppenderSkeleton.BufferSize"/> option. The
- <see cref="T:log4net.Appender.SmtpAppender"/> keeps only the last
- <see cref="P:log4net.Appender.BufferingAppenderSkeleton.BufferSize"/> logging events in its
- cyclic buffer. This keeps memory requirements at a reasonable level while
- still delivering useful application context.
- </para>
- <note type="caution">
- Authentication and setting the server Port are only available on the MS .NET 1.1 runtime.
- For these features to be enabled you need to ensure that you are using a version of
- the log4net assembly that is built against the MS .NET 1.1 framework and that you are
- running the your application on the MS .NET 1.1 runtime. On all other platforms only sending
- unauthenticated messages to a server listening on port 25 (the default) is supported.
- </note>
- <para>
- Authentication is supported by setting the <see cref="P:log4net.Appender.SmtpAppender.Authentication"/> property to
- either <see cref="F:log4net.Appender.SmtpAppender.SmtpAuthentication.Basic"/> or <see cref="F:log4net.Appender.SmtpAppender.SmtpAuthentication.Ntlm"/>.
- If using <see cref="F:log4net.Appender.SmtpAppender.SmtpAuthentication.Basic"/> authentication then the <see cref="P:log4net.Appender.SmtpAppender.Username"/>
- and <see cref="P:log4net.Appender.SmtpAppender.Password"/> properties must also be set.
- </para>
- <para>
- To set the SMTP server port use the <see cref="P:log4net.Appender.SmtpAppender.Port"/> property. The default port is 25.
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- <author>Gert Driesen</author>
- </member>
- <member name="M:log4net.Appender.SmtpAppender.#ctor">
- <summary>
- Default constructor
- </summary>
- <remarks>
- <para>
- Default constructor
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.SmtpAppender.SendBuffer(log4net.Core.LoggingEvent[])">
- <summary>
- Sends the contents of the cyclic buffer as an e-mail message.
- </summary>
- <param name="events">The logging events to send.</param>
- </member>
- <member name="M:log4net.Appender.SmtpAppender.SendEmail(System.String)">
- <summary>
- Send the email message
- </summary>
- <param name="messageBody">the body text to include in the mail</param>
- </member>
- <member name="P:log4net.Appender.SmtpAppender.To">
- <summary>
- Gets or sets a comma- or semicolon-delimited list of recipient e-mail addresses (use semicolon on .NET 1.1 and comma for later versions).
- </summary>
- <value>
- <para>
- For .NET 1.1 (System.Web.Mail): A semicolon-delimited list of e-mail addresses.
- </para>
- <para>
- For .NET 2.0 (System.Net.Mail): A comma-delimited list of e-mail addresses.
- </para>
- </value>
- <remarks>
- <para>
- For .NET 1.1 (System.Web.Mail): A semicolon-delimited list of e-mail addresses.
- </para>
- <para>
- For .NET 2.0 (System.Net.Mail): A comma-delimited list of e-mail addresses.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Appender.SmtpAppender.Cc">
- <summary>
- Gets or sets a comma- or semicolon-delimited list of recipient e-mail addresses
- that will be carbon copied (use semicolon on .NET 1.1 and comma for later versions).
- </summary>
- <value>
- <para>
- For .NET 1.1 (System.Web.Mail): A semicolon-delimited list of e-mail addresses.
- </para>
- <para>
- For .NET 2.0 (System.Net.Mail): A comma-delimited list of e-mail addresses.
- </para>
- </value>
- <remarks>
- <para>
- For .NET 1.1 (System.Web.Mail): A semicolon-delimited list of e-mail addresses.
- </para>
- <para>
- For .NET 2.0 (System.Net.Mail): A comma-delimited list of e-mail addresses.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Appender.SmtpAppender.Bcc">
- <summary>
- Gets or sets a semicolon-delimited list of recipient e-mail addresses
- that will be blind carbon copied.
- </summary>
- <value>
- A semicolon-delimited list of e-mail addresses.
- </value>
- <remarks>
- <para>
- A semicolon-delimited list of recipient e-mail addresses.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Appender.SmtpAppender.From">
- <summary>
- Gets or sets the e-mail address of the sender.
- </summary>
- <value>
- The e-mail address of the sender.
- </value>
- <remarks>
- <para>
- The e-mail address of the sender.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Appender.SmtpAppender.Subject">
- <summary>
- Gets or sets the subject line of the e-mail message.
- </summary>
- <value>
- The subject line of the e-mail message.
- </value>
- <remarks>
- <para>
- The subject line of the e-mail message.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Appender.SmtpAppender.SmtpHost">
- <summary>
- Gets or sets the name of the SMTP relay mail server to use to send
- the e-mail messages.
- </summary>
- <value>
- The name of the e-mail relay server. If SmtpServer is not set, the
- name of the local SMTP server is used.
- </value>
- <remarks>
- <para>
- The name of the e-mail relay server. If SmtpServer is not set, the
- name of the local SMTP server is used.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Appender.SmtpAppender.LocationInfo">
- <summary>
- Obsolete
- </summary>
- <remarks>
- Use the BufferingAppenderSkeleton Fix methods instead
- </remarks>
- <remarks>
- <para>
- Obsolete property.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Appender.SmtpAppender.Authentication">
- <summary>
- The mode to use to authentication with the SMTP server
- </summary>
- <remarks>
- <note type="caution">Authentication is only available on the MS .NET 1.1 runtime.</note>
- <para>
- Valid Authentication mode values are: <see cref="F:log4net.Appender.SmtpAppender.SmtpAuthentication.None"/>,
- <see cref="F:log4net.Appender.SmtpAppender.SmtpAuthentication.Basic"/>, and <see cref="F:log4net.Appender.SmtpAppender.SmtpAuthentication.Ntlm"/>.
- The default value is <see cref="F:log4net.Appender.SmtpAppender.SmtpAuthentication.None"/>. When using
- <see cref="F:log4net.Appender.SmtpAppender.SmtpAuthentication.Basic"/> you must specify the <see cref="P:log4net.Appender.SmtpAppender.Username"/>
- and <see cref="P:log4net.Appender.SmtpAppender.Password"/> to use to authenticate.
- When using <see cref="F:log4net.Appender.SmtpAppender.SmtpAuthentication.Ntlm"/> the Windows credentials for the current
- thread, if impersonating, or the process will be used to authenticate.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Appender.SmtpAppender.Username">
- <summary>
- The username to use to authenticate with the SMTP server
- </summary>
- <remarks>
- <note type="caution">Authentication is only available on the MS .NET 1.1 runtime.</note>
- <para>
- A <see cref="P:log4net.Appender.SmtpAppender.Username"/> and <see cref="P:log4net.Appender.SmtpAppender.Password"/> must be specified when
- <see cref="P:log4net.Appender.SmtpAppender.Authentication"/> is set to <see cref="F:log4net.Appender.SmtpAppender.SmtpAuthentication.Basic"/>,
- otherwise the username will be ignored.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Appender.SmtpAppender.Password">
- <summary>
- The password to use to authenticate with the SMTP server
- </summary>
- <remarks>
- <note type="caution">Authentication is only available on the MS .NET 1.1 runtime.</note>
- <para>
- A <see cref="P:log4net.Appender.SmtpAppender.Username"/> and <see cref="P:log4net.Appender.SmtpAppender.Password"/> must be specified when
- <see cref="P:log4net.Appender.SmtpAppender.Authentication"/> is set to <see cref="F:log4net.Appender.SmtpAppender.SmtpAuthentication.Basic"/>,
- otherwise the password will be ignored.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Appender.SmtpAppender.Port">
- <summary>
- The port on which the SMTP server is listening
- </summary>
- <remarks>
- <note type="caution">Server Port is only available on the MS .NET 1.1 runtime.</note>
- <para>
- The port on which the SMTP server is listening. The default
- port is <c>25</c>. The Port can only be changed when running on
- the MS .NET 1.1 runtime.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Appender.SmtpAppender.Priority">
- <summary>
- Gets or sets the priority of the e-mail message
- </summary>
- <value>
- One of the <see cref="T:System.Net.Mail.MailPriority"/> values.
- </value>
- <remarks>
- <para>
- Sets the priority of the e-mails generated by this
- appender. The default priority is <see cref="F:System.Net.Mail.MailPriority.Normal"/>.
- </para>
- <para>
- If you are using this appender to report errors then
- you may want to set the priority to <see cref="F:System.Net.Mail.MailPriority.High"/>.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Appender.SmtpAppender.EnableSsl">
- <summary>
- Enable or disable use of SSL when sending e-mail message
- </summary>
- <remarks>
- This is available on MS .NET 2.0 runtime and higher
- </remarks>
- </member>
- <member name="P:log4net.Appender.SmtpAppender.ReplyTo">
- <summary>
- Gets or sets the reply-to e-mail address.
- </summary>
- <remarks>
- This is available on MS .NET 2.0 runtime and higher
- </remarks>
- </member>
- <member name="P:log4net.Appender.SmtpAppender.SubjectEncoding">
- <summary>
- Gets or sets the subject encoding to be used.
- </summary>
- <remarks>
- The default encoding is the operating system's current ANSI codepage.
- </remarks>
- </member>
- <member name="P:log4net.Appender.SmtpAppender.BodyEncoding">
- <summary>
- Gets or sets the body encoding to be used.
- </summary>
- <remarks>
- The default encoding is the operating system's current ANSI codepage.
- </remarks>
- </member>
- <member name="P:log4net.Appender.SmtpAppender.RequiresLayout">
- <summary>
- This appender requires a <see cref="N:log4net.Layout"/> to be set.
- </summary>
- <value><c>true</c></value>
- <remarks>
- <para>
- This appender requires a <see cref="N:log4net.Layout"/> to be set.
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Appender.SmtpAppender.SmtpAuthentication">
- <summary>
- Values for the <see cref="P:log4net.Appender.SmtpAppender.Authentication"/> property.
- </summary>
- <remarks>
- <para>
- SMTP authentication modes.
- </para>
- </remarks>
- </member>
- <member name="F:log4net.Appender.SmtpAppender.SmtpAuthentication.None">
- <summary>
- No authentication
- </summary>
- </member>
- <member name="F:log4net.Appender.SmtpAppender.SmtpAuthentication.Basic">
- <summary>
- Basic authentication.
- </summary>
- <remarks>
- Requires a username and password to be supplied
- </remarks>
- </member>
- <member name="F:log4net.Appender.SmtpAppender.SmtpAuthentication.Ntlm">
- <summary>
- Integrated authentication
- </summary>
- <remarks>
- Uses the Windows credentials from the current thread or process to authenticate.
- </remarks>
- </member>
- <member name="T:log4net.Appender.SmtpPickupDirAppender">
- <summary>
- Send an email when a specific logging event occurs, typically on errors
- or fatal errors. Rather than sending via smtp it writes a file into the
- directory specified by <see cref="P:log4net.Appender.SmtpPickupDirAppender.PickupDir"/>. This allows services such
- as the IIS SMTP agent to manage sending the messages.
- </summary>
- <remarks>
- <para>
- The configuration for this appender is identical to that of the <c>SMTPAppender</c>,
- except that instead of specifying the <c>SMTPAppender.SMTPHost</c> you specify
- <see cref="P:log4net.Appender.SmtpPickupDirAppender.PickupDir"/>.
- </para>
- <para>
- The number of logging events delivered in this e-mail depend on
- the value of <see cref="P:log4net.Appender.BufferingAppenderSkeleton.BufferSize"/> option. The
- <see cref="T:log4net.Appender.SmtpPickupDirAppender"/> keeps only the last
- <see cref="P:log4net.Appender.BufferingAppenderSkeleton.BufferSize"/> logging events in its
- cyclic buffer. This keeps memory requirements at a reasonable level while
- still delivering useful application context.
- </para>
- </remarks>
- <author>Niall Daley</author>
- <author>Nicko Cadell</author>
- </member>
- <member name="M:log4net.Appender.SmtpPickupDirAppender.#ctor">
- <summary>
- Default constructor
- </summary>
- <remarks>
- <para>
- Default constructor
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.SmtpPickupDirAppender.SendBuffer(log4net.Core.LoggingEvent[])">
- <summary>
- Sends the contents of the cyclic buffer as an e-mail message.
- </summary>
- <param name="events">The logging events to send.</param>
- <remarks>
- <para>
- Sends the contents of the cyclic buffer as an e-mail message.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.SmtpPickupDirAppender.ActivateOptions">
- <summary>
- Activate the options on this appender.
- </summary>
- <remarks>
- <para>
- This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
- activation scheme. The <see cref="M:log4net.Appender.SmtpPickupDirAppender.ActivateOptions"/> method must
- be called on this object after the configuration properties have
- been set. Until <see cref="M:log4net.Appender.SmtpPickupDirAppender.ActivateOptions"/> is called this
- object is in an undefined state and must not be used.
- </para>
- <para>
- If any of the configuration properties are modified then
- <see cref="M:log4net.Appender.SmtpPickupDirAppender.ActivateOptions"/> must be called again.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.SmtpPickupDirAppender.ConvertToFullPath(System.String)">
- <summary>
- Convert a path into a fully qualified path.
- </summary>
- <param name="path">The path to convert.</param>
- <returns>The fully qualified path.</returns>
- <remarks>
- <para>
- Converts the path specified to a fully
- qualified path. If the path is relative it is
- taken as relative from the application base
- directory.
- </para>
- </remarks>
- </member>
- <member name="F:log4net.Appender.SmtpPickupDirAppender.m_securityContext">
- <summary>
- The security context to use for privileged calls
- </summary>
- </member>
- <member name="P:log4net.Appender.SmtpPickupDirAppender.To">
- <summary>
- Gets or sets a semicolon-delimited list of recipient e-mail addresses.
- </summary>
- <value>
- A semicolon-delimited list of e-mail addresses.
- </value>
- <remarks>
- <para>
- A semicolon-delimited list of e-mail addresses.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Appender.SmtpPickupDirAppender.From">
- <summary>
- Gets or sets the e-mail address of the sender.
- </summary>
- <value>
- The e-mail address of the sender.
- </value>
- <remarks>
- <para>
- The e-mail address of the sender.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Appender.SmtpPickupDirAppender.Subject">
- <summary>
- Gets or sets the subject line of the e-mail message.
- </summary>
- <value>
- The subject line of the e-mail message.
- </value>
- <remarks>
- <para>
- The subject line of the e-mail message.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Appender.SmtpPickupDirAppender.PickupDir">
- <summary>
- Gets or sets the path to write the messages to.
- </summary>
- <remarks>
- <para>
- Gets or sets the path to write the messages to. This should be the same
- as that used by the agent sending the messages.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Appender.SmtpPickupDirAppender.SecurityContext">
- <summary>
- Gets or sets the <see cref="P:log4net.Appender.SmtpPickupDirAppender.SecurityContext"/> used to write to the pickup directory.
- </summary>
- <value>
- The <see cref="P:log4net.Appender.SmtpPickupDirAppender.SecurityContext"/> used to write to the pickup directory.
- </value>
- <remarks>
- <para>
- Unless a <see cref="P:log4net.Appender.SmtpPickupDirAppender.SecurityContext"/> specified here for this appender
- the <see cref="P:log4net.Core.SecurityContextProvider.DefaultProvider"/> is queried for the
- security context to use. The default behavior is to use the security context
- of the current thread.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Appender.SmtpPickupDirAppender.RequiresLayout">
- <summary>
- This appender requires a <see cref="N:log4net.Layout"/> to be set.
- </summary>
- <value><c>true</c></value>
- <remarks>
- <para>
- This appender requires a <see cref="N:log4net.Layout"/> to be set.
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Appender.TelnetAppender">
- <summary>
- Appender that allows clients to connect via Telnet to receive log messages
- </summary>
- <remarks>
- <para>
- The TelnetAppender accepts socket connections and streams logging messages
- back to the client.
- The output is provided in a telnet-friendly way so that a log can be monitored
- over a TCP/IP socket.
- This allows simple remote monitoring of application logging.
- </para>
- <para>
- The default <see cref="P:log4net.Appender.TelnetAppender.Port"/> is 23 (the telnet port).
- </para>
- </remarks>
- <author>Keith Long</author>
- <author>Nicko Cadell</author>
- </member>
- <member name="M:log4net.Appender.TelnetAppender.#ctor">
- <summary>
- Default constructor
- </summary>
- <remarks>
- <para>
- Default constructor
- </para>
- </remarks>
- </member>
- <member name="F:log4net.Appender.TelnetAppender.declaringType">
- <summary>
- The fully qualified type of the TelnetAppender class.
- </summary>
- <remarks>
- Used by the internal logger to record the Type of the
- log message.
- </remarks>
- </member>
- <member name="M:log4net.Appender.TelnetAppender.OnClose">
- <summary>
- Overrides the parent method to close the socket handler
- </summary>
- <remarks>
- <para>
- Closes all the outstanding connections.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.TelnetAppender.ActivateOptions">
- <summary>
- Initialize the appender based on the options set.
- </summary>
- <remarks>
- <para>
- This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
- activation scheme. The <see cref="M:log4net.Appender.TelnetAppender.ActivateOptions"/> method must
- be called on this object after the configuration properties have
- been set. Until <see cref="M:log4net.Appender.TelnetAppender.ActivateOptions"/> is called this
- object is in an undefined state and must not be used.
- </para>
- <para>
- If any of the configuration properties are modified then
- <see cref="M:log4net.Appender.TelnetAppender.ActivateOptions"/> must be called again.
- </para>
- <para>
- Create the socket handler and wait for connections
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.TelnetAppender.Append(log4net.Core.LoggingEvent)">
- <summary>
- Writes the logging event to each connected client.
- </summary>
- <param name="loggingEvent">The event to log.</param>
- <remarks>
- <para>
- Writes the logging event to each connected client.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Appender.TelnetAppender.Port">
- <summary>
- Gets or sets the TCP port number on which this <see cref="T:log4net.Appender.TelnetAppender"/> will listen for connections.
- </summary>
- <value>
- An integer value in the range <see cref="F:System.Net.IPEndPoint.MinPort"/> to <see cref="F:System.Net.IPEndPoint.MaxPort"/>
- indicating the TCP port number on which this <see cref="T:log4net.Appender.TelnetAppender"/> will listen for connections.
- </value>
- <remarks>
- <para>
- The default value is 23 (the telnet port).
- </para>
- </remarks>
- <exception cref="T:System.ArgumentOutOfRangeException">The value specified is less than <see cref="F:System.Net.IPEndPoint.MinPort"/>
- or greater than <see cref="F:System.Net.IPEndPoint.MaxPort"/>.</exception>
- </member>
- <member name="P:log4net.Appender.TelnetAppender.RequiresLayout">
- <summary>
- This appender requires a <see cref="N:log4net.Layout"/> to be set.
- </summary>
- <value><c>true</c></value>
- <remarks>
- <para>
- This appender requires a <see cref="N:log4net.Layout"/> to be set.
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Appender.TelnetAppender.SocketHandler">
- <summary>
- Helper class to manage connected clients
- </summary>
- <remarks>
- <para>
- The SocketHandler class is used to accept connections from
- clients. It is threaded so that clients can connect/disconnect
- asynchronously.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.TelnetAppender.SocketHandler.#ctor(System.Int32)">
- <summary>
- Opens a new server port on <paramref ref="port"/>
- </summary>
- <param name="port">the local port to listen on for connections</param>
- <remarks>
- <para>
- Creates a socket handler on the specified local server port.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.TelnetAppender.SocketHandler.Send(System.String)">
- <summary>
- Sends a string message to each of the connected clients
- </summary>
- <param name="message">the text to send</param>
- <remarks>
- <para>
- Sends a string message to each of the connected clients
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.TelnetAppender.SocketHandler.AddClient(log4net.Appender.TelnetAppender.SocketHandler.SocketClient)">
- <summary>
- Add a client to the internal clients list
- </summary>
- <param name="client">client to add</param>
- </member>
- <member name="M:log4net.Appender.TelnetAppender.SocketHandler.RemoveClient(log4net.Appender.TelnetAppender.SocketHandler.SocketClient)">
- <summary>
- Remove a client from the internal clients list
- </summary>
- <param name="client">client to remove</param>
- </member>
- <member name="M:log4net.Appender.TelnetAppender.SocketHandler.OnConnect(System.IAsyncResult)">
- <summary>
- Callback used to accept a connection on the server socket
- </summary>
- <param name="asyncResult">The result of the asynchronous operation</param>
- <remarks>
- <para>
- On connection adds to the list of connections
- if there are two many open connections you will be disconnected
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.TelnetAppender.SocketHandler.Dispose">
- <summary>
- Close all network connections
- </summary>
- <remarks>
- <para>
- Make sure we close all network connections
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Appender.TelnetAppender.SocketHandler.HasConnections">
- <summary>
- Test if this handler has active connections
- </summary>
- <value>
- <c>true</c> if this handler has active connections
- </value>
- <remarks>
- <para>
- This property will be <c>true</c> while this handler has
- active connections, that is at least one connection that
- the handler will attempt to send a message to.
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Appender.TelnetAppender.SocketHandler.SocketClient">
- <summary>
- Class that represents a client connected to this handler
- </summary>
- <remarks>
- <para>
- Class that represents a client connected to this handler
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.TelnetAppender.SocketHandler.SocketClient.#ctor(System.Net.Sockets.Socket)">
- <summary>
- Create this <see cref="T:log4net.Appender.TelnetAppender.SocketHandler.SocketClient"/> for the specified <see cref="T:System.Net.Sockets.Socket"/>
- </summary>
- <param name="socket">the client's socket</param>
- <remarks>
- <para>
- Opens a stream writer on the socket.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.TelnetAppender.SocketHandler.SocketClient.Send(System.String)">
- <summary>
- Write a string to the client
- </summary>
- <param name="message">string to send</param>
- <remarks>
- <para>
- Write a string to the client
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.TelnetAppender.SocketHandler.SocketClient.Dispose">
- <summary>
- Cleanup the clients connection
- </summary>
- <remarks>
- <para>
- Close the socket connection.
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Appender.TraceAppender">
- <summary>
- Appends log events to the <see cref="T:System.Diagnostics.Trace"/> system.
- </summary>
- <remarks>
- <para>
- The application configuration file can be used to control what listeners
- are actually used. See the MSDN documentation for the
- <see cref="T:System.Diagnostics.Trace"/> class for details on configuring the
- trace system.
- </para>
- <para>
- Events are written using the <c>System.Diagnostics.Trace.Write(string,string)</c>
- method. The event's logger name is the default value for the category parameter
- of the Write method.
- </para>
- <para>
- <b>Compact Framework</b><br/>
- The Compact Framework does not support the <see cref="T:System.Diagnostics.Trace"/>
- class for any operation except <c>Assert</c>. When using the Compact Framework this
- appender will write to the <see cref="T:System.Diagnostics.Debug"/> system rather than
- the Trace system. This appender will therefore behave like the <see cref="T:log4net.Appender.DebugAppender"/>.
- </para>
- </remarks>
- <author>Douglas de la Torre</author>
- <author>Nicko Cadell</author>
- <author>Gert Driesen</author>
- <author>Ron Grabowski</author>
- </member>
- <member name="M:log4net.Appender.TraceAppender.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:log4net.Appender.TraceAppender"/>.
- </summary>
- <remarks>
- <para>
- Default constructor.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.TraceAppender.#ctor(log4net.Layout.ILayout)">
- <summary>
- Initializes a new instance of the <see cref="T:log4net.Appender.TraceAppender"/>
- with a specified layout.
- </summary>
- <param name="layout">The layout to use with this appender.</param>
- <remarks>
- <para>
- Obsolete constructor.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Appender.TraceAppender.Append(log4net.Core.LoggingEvent)">
- <summary>
- Writes the logging event to the <see cref="T:System.Diagnostics.Trace"/> system.
- </summary>
- <param name="loggingEvent">The event to log.</param>
- <remarks>
- <para>
- Writes the logging event to the <see cref="T:System.Diagnostics.Trace"/> system.
- </para>
- </remarks>
- </member>
- <member name="F:log4net.Appender.TraceAppender.m_immediateFlush">
- <summary>
- Immediate flush means that the underlying writer or output stream
- will be flushed at the end of each append operation.
- </summary>
- <remarks>
- <para>
- Immediate flush is slower but ensures that each append request is
- actually written. If <see cref="P:log4net.Appender.TraceAppender.ImmediateFlush"/> is set to
- <c>false</c>, then there is a good chance that the last few
- logs events are not actually written to persistent media if and
- when the application crashes.
- </para>
- <para>
- The default value is <c>true</c>.</para>
- </remarks>
- </member>
- <member name="F:log4net.Appender.TraceAppender.m_category">
- <summary>
- Defaults to %logger
- </summary>
- </member>
- <member name="P:log4net.Appender.TraceAppender.ImmediateFlush">
- <summary>
- Gets or sets a value that indicates whether the appender will
- flush at the end of each write.
- </summary>
- <remarks>
- <para>The default behavior is to flush at the end of each
- write. If the option is set to<c>false</c>, then the underlying
- stream can defer writing to physical medium to a later time.
- </para>
- <para>
- Avoiding the flush operation at the end of each append results
- in a performance gain of 10 to 20 percent. However, there is safety
- trade-off involved in skipping flushing. Indeed, when flushing is
- skipped, then it is likely that the last few log events will not
- be recorded on disk when the application exits. This is a high
- price to pay even for a 20% performance gain.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Appender.TraceAppender.Category">
- <summary>
- The category parameter sent to the Trace method.
- </summary>
- <remarks>
- <para>
- Defaults to %logger which will use the logger name of the current
- <see cref="T:log4net.Core.LoggingEvent"/> as the category parameter.
- </para>
- <para>
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Appender.TraceAppender.RequiresLayout">
- <summary>
- This appender requires a <see cref="N:log4net.Layout"/> to be set.
- </summary>
- <value><c>true</c></value>
- <remarks>
- <para>
- This appender requires a <see cref="N:log4net.Layout"/> to be set.
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Config.AliasDomainAttribute">
- <summary>
- Assembly level attribute that specifies a domain to alias to this assembly's repository.
- </summary>
- <remarks>
- <para>
- <b>AliasDomainAttribute is obsolete. Use AliasRepositoryAttribute instead of AliasDomainAttribute.</b>
- </para>
- <para>
- An assembly's logger repository is defined by its <see cref="T:log4net.Config.DomainAttribute"/>,
- however this can be overridden by an assembly loaded before the target assembly.
- </para>
- <para>
- An assembly can alias another assembly's domain to its repository by
- specifying this attribute with the name of the target domain.
- </para>
- <para>
- This attribute can only be specified on the assembly and may be used
- as many times as necessary to alias all the required domains.
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- <author>Gert Driesen</author>
- </member>
- <member name="T:log4net.Config.AliasRepositoryAttribute">
- <summary>
- Assembly level attribute that specifies a repository to alias to this assembly's repository.
- </summary>
- <remarks>
- <para>
- An assembly's logger repository is defined by its <see cref="T:log4net.Config.RepositoryAttribute"/>,
- however this can be overridden by an assembly loaded before the target assembly.
- </para>
- <para>
- An assembly can alias another assembly's repository to its repository by
- specifying this attribute with the name of the target repository.
- </para>
- <para>
- This attribute can only be specified on the assembly and may be used
- as many times as necessary to alias all the required repositories.
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- <author>Gert Driesen</author>
- </member>
- <member name="M:log4net.Config.AliasRepositoryAttribute.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:log4net.Config.AliasRepositoryAttribute"/> class with
- the specified repository to alias to this assembly's repository.
- </summary>
- <param name="name">The repository to alias to this assemby's repository.</param>
- <remarks>
- <para>
- Initializes a new instance of the <see cref="T:log4net.Config.AliasRepositoryAttribute"/> class with
- the specified repository to alias to this assembly's repository.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Config.AliasRepositoryAttribute.Name">
- <summary>
- Gets or sets the repository to alias to this assemby's repository.
- </summary>
- <value>
- The repository to alias to this assemby's repository.
- </value>
- <remarks>
- <para>
- The name of the repository to alias to this assemby's repository.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Config.AliasDomainAttribute.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:log4net.Config.AliasDomainAttribute"/> class with
- the specified domain to alias to this assembly's repository.
- </summary>
- <param name="name">The domain to alias to this assemby's repository.</param>
- <remarks>
- <para>
- Obsolete. Use <see cref="T:log4net.Config.AliasRepositoryAttribute"/> instead of <see cref="T:log4net.Config.AliasDomainAttribute"/>.
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Config.BasicConfigurator">
- <summary>
- Use this class to quickly configure a <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/>.
- </summary>
- <remarks>
- <para>
- Allows very simple programmatic configuration of log4net.
- </para>
- <para>
- Only one appender can be configured using this configurator.
- The appender is set at the root of the hierarchy and all logging
- events will be delivered to that appender.
- </para>
- <para>
- Appenders can also implement the <see cref="T:log4net.Core.IOptionHandler"/> interface. Therefore
- they would require that the <see cref="M:log4net.Core.IOptionHandler.ActivateOptions()"/> method
- be called after the appenders properties have been configured.
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- <author>Gert Driesen</author>
- </member>
- <member name="F:log4net.Config.BasicConfigurator.declaringType">
- <summary>
- The fully qualified type of the BasicConfigurator class.
- </summary>
- <remarks>
- Used by the internal logger to record the Type of the
- log message.
- </remarks>
- </member>
- <member name="M:log4net.Config.BasicConfigurator.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:log4net.Config.BasicConfigurator"/> class.
- </summary>
- <remarks>
- <para>
- Uses a private access modifier to prevent instantiation of this class.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Config.BasicConfigurator.Configure">
- <summary>
- Initializes the log4net system with a default configuration.
- </summary>
- <remarks>
- <para>
- Initializes the log4net logging system using a <see cref="T:log4net.Appender.ConsoleAppender"/>
- that will write to <c>Console.Out</c>. The log messages are
- formatted using the <see cref="T:log4net.Layout.PatternLayout"/> layout object
- with the <see cref="F:log4net.Layout.PatternLayout.DetailConversionPattern"/>
- layout style.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Config.BasicConfigurator.Configure(log4net.Appender.IAppender)">
- <summary>
- Initializes the log4net system using the specified appender.
- </summary>
- <param name="appender">The appender to use to log all logging events.</param>
- <remarks>
- <para>
- Initializes the log4net system using the specified appender.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Config.BasicConfigurator.Configure(log4net.Appender.IAppender[])">
- <summary>
- Initializes the log4net system using the specified appenders.
- </summary>
- <param name="appenders">The appenders to use to log all logging events.</param>
- <remarks>
- <para>
- Initializes the log4net system using the specified appenders.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Config.BasicConfigurator.Configure(log4net.Repository.ILoggerRepository)">
- <summary>
- Initializes the <see cref="T:log4net.Repository.ILoggerRepository"/> with a default configuration.
- </summary>
- <param name="repository">The repository to configure.</param>
- <remarks>
- <para>
- Initializes the specified repository using a <see cref="T:log4net.Appender.ConsoleAppender"/>
- that will write to <c>Console.Out</c>. The log messages are
- formatted using the <see cref="T:log4net.Layout.PatternLayout"/> layout object
- with the <see cref="F:log4net.Layout.PatternLayout.DetailConversionPattern"/>
- layout style.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Config.BasicConfigurator.Configure(log4net.Repository.ILoggerRepository,log4net.Appender.IAppender)">
- <summary>
- Initializes the <see cref="T:log4net.Repository.ILoggerRepository"/> using the specified appender.
- </summary>
- <param name="repository">The repository to configure.</param>
- <param name="appender">The appender to use to log all logging events.</param>
- <remarks>
- <para>
- Initializes the <see cref="T:log4net.Repository.ILoggerRepository"/> using the specified appender.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Config.BasicConfigurator.Configure(log4net.Repository.ILoggerRepository,log4net.Appender.IAppender[])">
- <summary>
- Initializes the <see cref="T:log4net.Repository.ILoggerRepository"/> using the specified appenders.
- </summary>
- <param name="repository">The repository to configure.</param>
- <param name="appenders">The appenders to use to log all logging events.</param>
- <remarks>
- <para>
- Initializes the <see cref="T:log4net.Repository.ILoggerRepository"/> using the specified appender.
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Config.ConfiguratorAttribute">
- <summary>
- Base class for all log4net configuration attributes.
- </summary>
- <remarks>
- This is an abstract class that must be extended by
- specific configurators. This attribute allows the
- configurator to be parameterized by an assembly level
- attribute.
- </remarks>
- <author>Nicko Cadell</author>
- <author>Gert Driesen</author>
- </member>
- <member name="M:log4net.Config.ConfiguratorAttribute.#ctor(System.Int32)">
- <summary>
- Constructor used by subclasses.
- </summary>
- <param name="priority">the ordering priority for this configurator</param>
- <remarks>
- <para>
- The <paramref name="priority"/> is used to order the configurator
- attributes before they are invoked. Higher priority configurators are executed
- before lower priority ones.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Config.ConfiguratorAttribute.Configure(System.Reflection.Assembly,log4net.Repository.ILoggerRepository)">
- <summary>
- Configures the <see cref="T:log4net.Repository.ILoggerRepository"/> for the specified assembly.
- </summary>
- <param name="sourceAssembly">The assembly that this attribute was defined on.</param>
- <param name="targetRepository">The repository to configure.</param>
- <remarks>
- <para>
- Abstract method implemented by a subclass. When this method is called
- the subclass should configure the <paramref name="targetRepository"/>.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Config.ConfiguratorAttribute.CompareTo(System.Object)">
- <summary>
- Compare this instance to another ConfiguratorAttribute
- </summary>
- <param name="obj">the object to compare to</param>
- <returns>see <see cref="M:System.IComparable.CompareTo(System.Object)"/></returns>
- <remarks>
- <para>
- Compares the priorities of the two <see cref="T:log4net.Config.ConfiguratorAttribute"/> instances.
- Sorts by priority in descending order. Objects with the same priority are
- randomly ordered.
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Config.DomainAttribute">
- <summary>
- Assembly level attribute that specifies the logging domain for the assembly.
- </summary>
- <remarks>
- <para>
- <b>DomainAttribute is obsolete. Use RepositoryAttribute instead of DomainAttribute.</b>
- </para>
- <para>
- Assemblies are mapped to logging domains. Each domain has its own
- logging repository. This attribute specified on the assembly controls
- the configuration of the domain. The <see cref="P:log4net.Config.RepositoryAttribute.Name"/> property specifies the name
- of the domain that this assembly is a part of. The <see cref="P:log4net.Config.RepositoryAttribute.RepositoryType"/>
- specifies the type of the repository objects to create for the domain. If
- this attribute is not specified and a <see cref="P:log4net.Config.RepositoryAttribute.Name"/> is not specified
- then the assembly will be part of the default shared logging domain.
- </para>
- <para>
- This attribute can only be specified on the assembly and may only be used
- once per assembly.
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- <author>Gert Driesen</author>
- </member>
- <member name="T:log4net.Config.RepositoryAttribute">
- <summary>
- Assembly level attribute that specifies the logging repository for the assembly.
- </summary>
- <remarks>
- <para>
- Assemblies are mapped to logging repository. This attribute specified
- on the assembly controls
- the configuration of the repository. The <see cref="P:log4net.Config.RepositoryAttribute.Name"/> property specifies the name
- of the repository that this assembly is a part of. The <see cref="P:log4net.Config.RepositoryAttribute.RepositoryType"/>
- specifies the type of the <see cref="T:log4net.Repository.ILoggerRepository"/> object
- to create for the assembly. If this attribute is not specified or a <see cref="P:log4net.Config.RepositoryAttribute.Name"/>
- is not specified then the assembly will be part of the default shared logging repository.
- </para>
- <para>
- This attribute can only be specified on the assembly and may only be used
- once per assembly.
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- <author>Gert Driesen</author>
- </member>
- <member name="M:log4net.Config.RepositoryAttribute.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:log4net.Config.RepositoryAttribute"/> class.
- </summary>
- <remarks>
- <para>
- Default constructor.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Config.RepositoryAttribute.#ctor(System.String)">
- <summary>
- Initialize a new instance of the <see cref="T:log4net.Config.RepositoryAttribute"/> class
- with the name of the repository.
- </summary>
- <param name="name">The name of the repository.</param>
- <remarks>
- <para>
- Initialize the attribute with the name for the assembly's repository.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Config.RepositoryAttribute.Name">
- <summary>
- Gets or sets the name of the logging repository.
- </summary>
- <value>
- The string name to use as the name of the repository associated with this
- assembly.
- </value>
- <remarks>
- <para>
- This value does not have to be unique. Several assemblies can share the
- same repository. They will share the logging configuration of the repository.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Config.RepositoryAttribute.RepositoryType">
- <summary>
- Gets or sets the type of repository to create for this assembly.
- </summary>
- <value>
- The type of repository to create for this assembly.
- </value>
- <remarks>
- <para>
- The type of the repository to create for the assembly.
- The type must implement the <see cref="T:log4net.Repository.ILoggerRepository"/>
- interface.
- </para>
- <para>
- This will be the type of repository created when
- the repository is created. If multiple assemblies reference the
- same repository then the repository is only created once using the
- <see cref="P:log4net.Config.RepositoryAttribute.RepositoryType"/> of the first assembly to call into the
- repository.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Config.DomainAttribute.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:log4net.Config.DomainAttribute"/> class.
- </summary>
- <remarks>
- <para>
- Obsolete. Use RepositoryAttribute instead of DomainAttribute.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Config.DomainAttribute.#ctor(System.String)">
- <summary>
- Initialize a new instance of the <see cref="T:log4net.Config.DomainAttribute"/> class
- with the name of the domain.
- </summary>
- <param name="name">The name of the domain.</param>
- <remarks>
- <para>
- Obsolete. Use RepositoryAttribute instead of DomainAttribute.
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Config.DOMConfigurator">
- <summary>
- Use this class to initialize the log4net environment using an Xml tree.
- </summary>
- <remarks>
- <para>
- <b>DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator.</b>
- </para>
- <para>
- Configures a <see cref="T:log4net.Repository.ILoggerRepository"/> using an Xml tree.
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- <author>Gert Driesen</author>
- </member>
- <member name="M:log4net.Config.DOMConfigurator.#ctor">
- <summary>
- Private constructor
- </summary>
- </member>
- <member name="M:log4net.Config.DOMConfigurator.Configure">
- <summary>
- Automatically configures the log4net system based on the
- application's configuration settings.
- </summary>
- <remarks>
- <para>
- <b>DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator.</b>
- </para>
- Each application has a configuration file. This has the
- same name as the application with '.config' appended.
- This file is XML and calling this function prompts the
- configurator to look in that file for a section called
- <c>log4net</c> that contains the configuration data.
- </remarks>
- </member>
- <member name="M:log4net.Config.DOMConfigurator.Configure(log4net.Repository.ILoggerRepository)">
- <summary>
- Automatically configures the <see cref="T:log4net.Repository.ILoggerRepository"/> using settings
- stored in the application's configuration file.
- </summary>
- <remarks>
- <para>
- <b>DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator.</b>
- </para>
- Each application has a configuration file. This has the
- same name as the application with '.config' appended.
- This file is XML and calling this function prompts the
- configurator to look in that file for a section called
- <c>log4net</c> that contains the configuration data.
- </remarks>
- <param name="repository">The repository to configure.</param>
- </member>
- <member name="M:log4net.Config.DOMConfigurator.Configure(System.Xml.XmlElement)">
- <summary>
- Configures log4net using a <c>log4net</c> element
- </summary>
- <remarks>
- <para>
- <b>DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator.</b>
- </para>
- Loads the log4net configuration from the XML element
- supplied as <paramref name="element"/>.
- </remarks>
- <param name="element">The element to parse.</param>
- </member>
- <member name="M:log4net.Config.DOMConfigurator.Configure(log4net.Repository.ILoggerRepository,System.Xml.XmlElement)">
- <summary>
- Configures the <see cref="T:log4net.Repository.ILoggerRepository"/> using the specified XML
- element.
- </summary>
- <remarks>
- <para>
- <b>DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator.</b>
- </para>
- Loads the log4net configuration from the XML element
- supplied as <paramref name="element"/>.
- </remarks>
- <param name="repository">The repository to configure.</param>
- <param name="element">The element to parse.</param>
- </member>
- <member name="M:log4net.Config.DOMConfigurator.Configure(System.IO.FileInfo)">
- <summary>
- Configures log4net using the specified configuration file.
- </summary>
- <param name="configFile">The XML file to load the configuration from.</param>
- <remarks>
- <para>
- <b>DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator.</b>
- </para>
- <para>
- The configuration file must be valid XML. It must contain
- at least one element called <c>log4net</c> that holds
- the log4net configuration data.
- </para>
- <para>
- The log4net configuration file can possible be specified in the application's
- configuration file (either <c>MyAppName.exe.config</c> for a
- normal application on <c>Web.config</c> for an ASP.NET application).
- </para>
- <example>
- The following example configures log4net using a configuration file, of which the
- location is stored in the application's configuration file :
- </example>
- <code lang="C#">
- using log4net.Config;
- using System.IO;
- using System.Configuration;
-
- ...
-
- DOMConfigurator.Configure(new FileInfo(ConfigurationSettings.AppSettings["log4net-config-file"]));
- </code>
- <para>
- In the <c>.config</c> file, the path to the log4net can be specified like this :
- </para>
- <code lang="XML" escaped="true">
- <configuration>
- <appSettings>
- <add key="log4net-config-file" value="log.config"/>
- </appSettings>
- </configuration>
- </code>
- </remarks>
- </member>
- <member name="M:log4net.Config.DOMConfigurator.Configure(System.IO.Stream)">
- <summary>
- Configures log4net using the specified configuration file.
- </summary>
- <param name="configStream">A stream to load the XML configuration from.</param>
- <remarks>
- <para>
- <b>DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator.</b>
- </para>
- <para>
- The configuration data must be valid XML. It must contain
- at least one element called <c>log4net</c> that holds
- the log4net configuration data.
- </para>
- <para>
- Note that this method will NOT close the stream parameter.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Config.DOMConfigurator.Configure(log4net.Repository.ILoggerRepository,System.IO.FileInfo)">
- <summary>
- Configures the <see cref="T:log4net.Repository.ILoggerRepository"/> using the specified configuration
- file.
- </summary>
- <param name="repository">The repository to configure.</param>
- <param name="configFile">The XML file to load the configuration from.</param>
- <remarks>
- <para>
- <b>DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator.</b>
- </para>
- <para>
- The configuration file must be valid XML. It must contain
- at least one element called <c>log4net</c> that holds
- the configuration data.
- </para>
- <para>
- The log4net configuration file can possible be specified in the application's
- configuration file (either <c>MyAppName.exe.config</c> for a
- normal application on <c>Web.config</c> for an ASP.NET application).
- </para>
- <example>
- The following example configures log4net using a configuration file, of which the
- location is stored in the application's configuration file :
- </example>
- <code lang="C#">
- using log4net.Config;
- using System.IO;
- using System.Configuration;
-
- ...
-
- DOMConfigurator.Configure(new FileInfo(ConfigurationSettings.AppSettings["log4net-config-file"]));
- </code>
- <para>
- In the <c>.config</c> file, the path to the log4net can be specified like this :
- </para>
- <code lang="XML" escaped="true">
- <configuration>
- <appSettings>
- <add key="log4net-config-file" value="log.config"/>
- </appSettings>
- </configuration>
- </code>
- </remarks>
- </member>
- <member name="M:log4net.Config.DOMConfigurator.Configure(log4net.Repository.ILoggerRepository,System.IO.Stream)">
- <summary>
- Configures the <see cref="T:log4net.Repository.ILoggerRepository"/> using the specified configuration
- file.
- </summary>
- <param name="repository">The repository to configure.</param>
- <param name="configStream">The stream to load the XML configuration from.</param>
- <remarks>
- <para>
- <b>DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator.</b>
- </para>
- <para>
- The configuration data must be valid XML. It must contain
- at least one element called <c>log4net</c> that holds
- the configuration data.
- </para>
- <para>
- Note that this method will NOT close the stream parameter.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Config.DOMConfigurator.ConfigureAndWatch(System.IO.FileInfo)">
- <summary>
- Configures log4net using the file specified, monitors the file for changes
- and reloads the configuration if a change is detected.
- </summary>
- <param name="configFile">The XML file to load the configuration from.</param>
- <remarks>
- <para>
- <b>DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator.</b>
- </para>
- <para>
- The configuration file must be valid XML. It must contain
- at least one element called <c>log4net</c> that holds
- the configuration data.
- </para>
- <para>
- The configuration file will be monitored using a <see cref="T:System.IO.FileSystemWatcher"/>
- and depends on the behavior of that class.
- </para>
- <para>
- For more information on how to configure log4net using
- a separate configuration file, see <see cref="M:Configure(FileInfo)"/>.
- </para>
- </remarks>
- <seealso cref="M:Configure(FileInfo)"/>
- </member>
- <member name="M:log4net.Config.DOMConfigurator.ConfigureAndWatch(log4net.Repository.ILoggerRepository,System.IO.FileInfo)">
- <summary>
- Configures the <see cref="T:log4net.Repository.ILoggerRepository"/> using the file specified,
- monitors the file for changes and reloads the configuration if a change
- is detected.
- </summary>
- <param name="repository">The repository to configure.</param>
- <param name="configFile">The XML file to load the configuration from.</param>
- <remarks>
- <para>
- <b>DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator.</b>
- </para>
- <para>
- The configuration file must be valid XML. It must contain
- at least one element called <c>log4net</c> that holds
- the configuration data.
- </para>
- <para>
- The configuration file will be monitored using a <see cref="T:System.IO.FileSystemWatcher"/>
- and depends on the behavior of that class.
- </para>
- <para>
- For more information on how to configure log4net using
- a separate configuration file, see <see cref="M:Configure(FileInfo)"/>.
- </para>
- </remarks>
- <seealso cref="M:Configure(FileInfo)"/>
- </member>
- <member name="T:log4net.Config.DOMConfiguratorAttribute">
- <summary>
- Assembly level attribute to configure the <see cref="T:log4net.Config.XmlConfigurator"/>.
- </summary>
- <remarks>
- <para>
- <b>AliasDomainAttribute is obsolete. Use AliasRepositoryAttribute instead of AliasDomainAttribute.</b>
- </para>
- <para>
- This attribute may only be used at the assembly scope and can only
- be used once per assembly.
- </para>
- <para>
- Use this attribute to configure the <see cref="T:log4net.Config.XmlConfigurator"/>
- without calling one of the <see cref="M:XmlConfigurator.Configure()"/>
- methods.
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- <author>Gert Driesen</author>
- </member>
- <member name="T:log4net.Config.XmlConfiguratorAttribute">
- <summary>
- Assembly level attribute to configure the <see cref="T:log4net.Config.XmlConfigurator"/>.
- </summary>
- <remarks>
- <para>
- This attribute may only be used at the assembly scope and can only
- be used once per assembly.
- </para>
- <para>
- Use this attribute to configure the <see cref="T:log4net.Config.XmlConfigurator"/>
- without calling one of the <see cref="M:XmlConfigurator.Configure()"/>
- methods.
- </para>
- <para>
- If neither of the <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFile"/> or <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFileExtension"/>
- properties are set the configuration is loaded from the application's .config file.
- If set the <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFile"/> property takes priority over the
- <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFileExtension"/> property. The <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFile"/> property
- specifies a path to a file to load the config from. The path is relative to the
- application's base directory; <see cref="P:System.AppDomain.BaseDirectory"/>.
- The <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFileExtension"/> property is used as a postfix to the assembly file name.
- The config file must be located in the application's base directory; <see cref="P:System.AppDomain.BaseDirectory"/>.
- For example in a console application setting the <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFileExtension"/> to
- <c>config</c> has the same effect as not specifying the <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFile"/> or
- <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFileExtension"/> properties.
- </para>
- <para>
- The <see cref="P:log4net.Config.XmlConfiguratorAttribute.Watch"/> property can be set to cause the <see cref="T:log4net.Config.XmlConfigurator"/>
- to watch the configuration file for changes.
- </para>
- <note>
- <para>
- Log4net will only look for assembly level configuration attributes once.
- When using the log4net assembly level attributes to control the configuration
- of log4net you must ensure that the first call to any of the
- <see cref="T:log4net.Core.LoggerManager"/> methods is made from the assembly with the configuration
- attributes.
- </para>
- <para>
- If you cannot guarantee the order in which log4net calls will be made from
- different assemblies you must use programmatic configuration instead, i.e.
- call the <see cref="M:XmlConfigurator.Configure()"/> method directly.
- </para>
- </note>
- </remarks>
- <author>Nicko Cadell</author>
- <author>Gert Driesen</author>
- </member>
- <member name="M:log4net.Config.XmlConfiguratorAttribute.#ctor">
- <summary>
- Default constructor
- </summary>
- <remarks>
- <para>
- Default constructor
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Config.XmlConfiguratorAttribute.Configure(System.Reflection.Assembly,log4net.Repository.ILoggerRepository)">
- <summary>
- Configures the <see cref="T:log4net.Repository.ILoggerRepository"/> for the specified assembly.
- </summary>
- <param name="sourceAssembly">The assembly that this attribute was defined on.</param>
- <param name="targetRepository">The repository to configure.</param>
- <remarks>
- <para>
- Configure the repository using the <see cref="T:log4net.Config.XmlConfigurator"/>.
- The <paramref name="targetRepository"/> specified must extend the <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/>
- class otherwise the <see cref="T:log4net.Config.XmlConfigurator"/> will not be able to
- configure it.
- </para>
- </remarks>
- <exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="targetRepository"/> does not extend <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/>.</exception>
- </member>
- <member name="M:log4net.Config.XmlConfiguratorAttribute.ConfigureFromFile(System.Reflection.Assembly,log4net.Repository.ILoggerRepository)">
- <summary>
- Attempt to load configuration from the local file system
- </summary>
- <param name="sourceAssembly">The assembly that this attribute was defined on.</param>
- <param name="targetRepository">The repository to configure.</param>
- </member>
- <member name="M:log4net.Config.XmlConfiguratorAttribute.ConfigureFromFile(log4net.Repository.ILoggerRepository,System.IO.FileInfo)">
- <summary>
- Configure the specified repository using a <see cref="T:System.IO.FileInfo"/>
- </summary>
- <param name="targetRepository">The repository to configure.</param>
- <param name="configFile">the FileInfo pointing to the config file</param>
- </member>
- <member name="M:log4net.Config.XmlConfiguratorAttribute.ConfigureFromUri(System.Reflection.Assembly,log4net.Repository.ILoggerRepository)">
- <summary>
- Attempt to load configuration from a URI
- </summary>
- <param name="sourceAssembly">The assembly that this attribute was defined on.</param>
- <param name="targetRepository">The repository to configure.</param>
- </member>
- <member name="F:log4net.Config.XmlConfiguratorAttribute.declaringType">
- <summary>
- The fully qualified type of the XmlConfiguratorAttribute class.
- </summary>
- <remarks>
- Used by the internal logger to record the Type of the
- log message.
- </remarks>
- </member>
- <member name="P:log4net.Config.XmlConfiguratorAttribute.ConfigFile">
- <summary>
- Gets or sets the filename of the configuration file.
- </summary>
- <value>
- The filename of the configuration file.
- </value>
- <remarks>
- <para>
- If specified, this is the name of the configuration file to use with
- the <see cref="T:log4net.Config.XmlConfigurator"/>. This file path is relative to the
- <b>application base</b> directory (<see cref="P:System.AppDomain.BaseDirectory"/>).
- </para>
- <para>
- The <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFile"/> takes priority over the <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFileExtension"/>.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Config.XmlConfiguratorAttribute.ConfigFileExtension">
- <summary>
- Gets or sets the extension of the configuration file.
- </summary>
- <value>
- The extension of the configuration file.
- </value>
- <remarks>
- <para>
- If specified this is the extension for the configuration file.
- The path to the config file is built by using the <b>application
- base</b> directory (<see cref="P:System.AppDomain.BaseDirectory"/>),
- the <b>assembly file name</b> and the config file extension.
- </para>
- <para>
- If the <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFileExtension"/> is set to <c>MyExt</c> then
- possible config file names would be: <c>MyConsoleApp.exe.MyExt</c> or
- <c>MyClassLibrary.dll.MyExt</c>.
- </para>
- <para>
- The <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFile"/> takes priority over the <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFileExtension"/>.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Config.XmlConfiguratorAttribute.Watch">
- <summary>
- Gets or sets a value indicating whether to watch the configuration file.
- </summary>
- <value>
- <c>true</c> if the configuration should be watched, <c>false</c> otherwise.
- </value>
- <remarks>
- <para>
- If this flag is specified and set to <c>true</c> then the framework
- will watch the configuration file and will reload the config each time
- the file is modified.
- </para>
- <para>
- The config file can only be watched if it is loaded from local disk.
- In a No-Touch (Smart Client) deployment where the application is downloaded
- from a web server the config file may not reside on the local disk
- and therefore it may not be able to watch it.
- </para>
- <note>
- Watching configuration is not supported on the SSCLI.
- </note>
- </remarks>
- </member>
- <member name="T:log4net.Config.Log4NetConfigurationSectionHandler">
- <summary>
- Class to register for the log4net section of the configuration file
- </summary>
- <remarks>
- The log4net section of the configuration file needs to have a section
- handler registered. This is the section handler used. It simply returns
- the XML element that is the root of the section.
- </remarks>
- <example>
- Example of registering the log4net section handler :
- <code lang="XML" escaped="true">
- <configuration>
- <configSections>
- <section name="log4net" type="log4net.Config.Log4NetConfigurationSectionHandler, log4net" />
- </configSections>
- <log4net>
- log4net configuration XML goes here
- </log4net>
- </configuration>
- </code>
- </example>
- <author>Nicko Cadell</author>
- <author>Gert Driesen</author>
- </member>
- <member name="M:log4net.Config.Log4NetConfigurationSectionHandler.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:log4net.Config.Log4NetConfigurationSectionHandler"/> class.
- </summary>
- <remarks>
- <para>
- Default constructor.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Config.Log4NetConfigurationSectionHandler.Create(System.Object,System.Object,System.Xml.XmlNode)">
- <summary>
- Parses the configuration section.
- </summary>
- <param name="parent">The configuration settings in a corresponding parent configuration section.</param>
- <param name="configContext">The configuration context when called from the ASP.NET configuration system. Otherwise, this parameter is reserved and is a null reference.</param>
- <param name="section">The <see cref="T:System.Xml.XmlNode"/> for the log4net section.</param>
- <returns>The <see cref="T:System.Xml.XmlNode"/> for the log4net section.</returns>
- <remarks>
- <para>
- Returns the <see cref="T:System.Xml.XmlNode"/> containing the configuration data,
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Config.PluginAttribute">
- <summary>
- Assembly level attribute that specifies a plugin to attach to
- the repository.
- </summary>
- <remarks>
- <para>
- Specifies the type of a plugin to create and attach to the
- assembly's repository. The plugin type must implement the
- <see cref="T:log4net.Plugin.IPlugin"/> interface.
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- <author>Gert Driesen</author>
- </member>
- <member name="T:log4net.Plugin.IPluginFactory">
- <summary>
- Interface used to create plugins.
- </summary>
- <remarks>
- <para>
- Interface used to create a plugin.
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- <author>Gert Driesen</author>
- </member>
- <member name="M:log4net.Plugin.IPluginFactory.CreatePlugin">
- <summary>
- Creates the plugin object.
- </summary>
- <returns>the new plugin instance</returns>
- <remarks>
- <para>
- Create and return a new plugin instance.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Config.PluginAttribute.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:log4net.Config.PluginAttribute"/> class
- with the specified type.
- </summary>
- <param name="typeName">The type name of plugin to create.</param>
- <remarks>
- <para>
- Create the attribute with the plugin type specified.
- </para>
- <para>
- Where possible use the constructor that takes a <see cref="T:System.Type"/>.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Config.PluginAttribute.#ctor(System.Type)">
- <summary>
- Initializes a new instance of the <see cref="T:log4net.Config.PluginAttribute"/> class
- with the specified type.
- </summary>
- <param name="type">The type of plugin to create.</param>
- <remarks>
- <para>
- Create the attribute with the plugin type specified.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Config.PluginAttribute.CreatePlugin">
- <summary>
- Creates the plugin object defined by this attribute.
- </summary>
- <remarks>
- <para>
- Creates the instance of the <see cref="T:log4net.Plugin.IPlugin"/> object as
- specified by this attribute.
- </para>
- </remarks>
- <returns>The plugin object.</returns>
- </member>
- <member name="M:log4net.Config.PluginAttribute.ToString">
- <summary>
- Returns a representation of the properties of this object.
- </summary>
- <remarks>
- <para>
- Overrides base class <see cref="M:Object.ToString()" /> method to
- return a representation of the properties of this object.
- </para>
- </remarks>
- <returns>A representation of the properties of this object</returns>
- </member>
- <member name="P:log4net.Config.PluginAttribute.Type">
- <summary>
- Gets or sets the type for the plugin.
- </summary>
- <value>
- The type for the plugin.
- </value>
- <remarks>
- <para>
- The type for the plugin.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Config.PluginAttribute.TypeName">
- <summary>
- Gets or sets the type name for the plugin.
- </summary>
- <value>
- The type name for the plugin.
- </value>
- <remarks>
- <para>
- The type name for the plugin.
- </para>
- <para>
- Where possible use the <see cref="P:log4net.Config.PluginAttribute.Type"/> property instead.
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Config.SecurityContextProviderAttribute">
- <summary>
- Assembly level attribute to configure the <see cref="T:log4net.Core.SecurityContextProvider"/>.
- </summary>
- <remarks>
- <para>
- This attribute may only be used at the assembly scope and can only
- be used once per assembly.
- </para>
- <para>
- Use this attribute to configure the <see cref="T:log4net.Config.XmlConfigurator"/>
- without calling one of the <see cref="M:XmlConfigurator.Configure()"/>
- methods.
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- </member>
- <member name="M:log4net.Config.SecurityContextProviderAttribute.#ctor(System.Type)">
- <summary>
- Construct provider attribute with type specified
- </summary>
- <param name="providerType">the type of the provider to use</param>
- <remarks>
- <para>
- The provider specified must subclass the <see cref="T:log4net.Core.SecurityContextProvider"/>
- class.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Config.SecurityContextProviderAttribute.Configure(System.Reflection.Assembly,log4net.Repository.ILoggerRepository)">
- <summary>
- Configures the SecurityContextProvider
- </summary>
- <param name="sourceAssembly">The assembly that this attribute was defined on.</param>
- <param name="targetRepository">The repository to configure.</param>
- <remarks>
- <para>
- Creates a provider instance from the <see cref="P:log4net.Config.SecurityContextProviderAttribute.ProviderType"/> specified.
- Sets this as the default security context provider <see cref="P:log4net.Core.SecurityContextProvider.DefaultProvider"/>.
- </para>
- </remarks>
- </member>
- <member name="F:log4net.Config.SecurityContextProviderAttribute.declaringType">
- <summary>
- The fully qualified type of the SecurityContextProviderAttribute class.
- </summary>
- <remarks>
- Used by the internal logger to record the Type of the
- log message.
- </remarks>
- </member>
- <member name="P:log4net.Config.SecurityContextProviderAttribute.ProviderType">
- <summary>
- Gets or sets the type of the provider to use.
- </summary>
- <value>
- the type of the provider to use.
- </value>
- <remarks>
- <para>
- The provider specified must subclass the <see cref="T:log4net.Core.SecurityContextProvider"/>
- class.
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Config.XmlConfigurator">
- <summary>
- Use this class to initialize the log4net environment using an Xml tree.
- </summary>
- <remarks>
- <para>
- Configures a <see cref="T:log4net.Repository.ILoggerRepository"/> using an Xml tree.
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- <author>Gert Driesen</author>
- </member>
- <member name="M:log4net.Config.XmlConfigurator.#ctor">
- <summary>
- Private constructor
- </summary>
- </member>
- <member name="M:log4net.Config.XmlConfigurator.Configure">
- <summary>
- Automatically configures the log4net system based on the
- application's configuration settings.
- </summary>
- <remarks>
- <para>
- Each application has a configuration file. This has the
- same name as the application with '.config' appended.
- This file is XML and calling this function prompts the
- configurator to look in that file for a section called
- <c>log4net</c> that contains the configuration data.
- </para>
- <para>
- To use this method to configure log4net you must specify
- the <see cref="T:log4net.Config.Log4NetConfigurationSectionHandler"/> section
- handler for the <c>log4net</c> configuration section. See the
- <see cref="T:log4net.Config.Log4NetConfigurationSectionHandler"/> for an example.
- </para>
- </remarks>
- <seealso cref="T:log4net.Config.Log4NetConfigurationSectionHandler"/>
- </member>
- <member name="M:log4net.Config.XmlConfigurator.Configure(log4net.Repository.ILoggerRepository)">
- <summary>
- Automatically configures the <see cref="T:log4net.Repository.ILoggerRepository"/> using settings
- stored in the application's configuration file.
- </summary>
- <remarks>
- <para>
- Each application has a configuration file. This has the
- same name as the application with '.config' appended.
- This file is XML and calling this function prompts the
- configurator to look in that file for a section called
- <c>log4net</c> that contains the configuration data.
- </para>
- <para>
- To use this method to configure log4net you must specify
- the <see cref="T:log4net.Config.Log4NetConfigurationSectionHandler"/> section
- handler for the <c>log4net</c> configuration section. See the
- <see cref="T:log4net.Config.Log4NetConfigurationSectionHandler"/> for an example.
- </para>
- </remarks>
- <param name="repository">The repository to configure.</param>
- </member>
- <member name="M:log4net.Config.XmlConfigurator.Configure(System.Xml.XmlElement)">
- <summary>
- Configures log4net using a <c>log4net</c> element
- </summary>
- <remarks>
- <para>
- Loads the log4net configuration from the XML element
- supplied as <paramref name="element"/>.
- </para>
- </remarks>
- <param name="element">The element to parse.</param>
- </member>
- <member name="M:log4net.Config.XmlConfigurator.Configure(log4net.Repository.ILoggerRepository,System.Xml.XmlElement)">
- <summary>
- Configures the <see cref="T:log4net.Repository.ILoggerRepository"/> using the specified XML
- element.
- </summary>
- <remarks>
- Loads the log4net configuration from the XML element
- supplied as <paramref name="element"/>.
- </remarks>
- <param name="repository">The repository to configure.</param>
- <param name="element">The element to parse.</param>
- </member>
- <member name="M:log4net.Config.XmlConfigurator.Configure(System.IO.FileInfo)">
- <summary>
- Configures log4net using the specified configuration file.
- </summary>
- <param name="configFile">The XML file to load the configuration from.</param>
- <remarks>
- <para>
- The configuration file must be valid XML. It must contain
- at least one element called <c>log4net</c> that holds
- the log4net configuration data.
- </para>
- <para>
- The log4net configuration file can possible be specified in the application's
- configuration file (either <c>MyAppName.exe.config</c> for a
- normal application on <c>Web.config</c> for an ASP.NET application).
- </para>
- <para>
- The first element matching <c><configuration></c> will be read as the
- configuration. If this file is also a .NET .config file then you must specify
- a configuration section for the <c>log4net</c> element otherwise .NET will
- complain. Set the type for the section handler to <see cref="T:System.Configuration.IgnoreSectionHandler"/>, for example:
- <code lang="XML" escaped="true">
- <configSections>
- <section name="log4net" type="System.Configuration.IgnoreSectionHandler"/>
- </configSections>
- </code>
- </para>
- <example>
- The following example configures log4net using a configuration file, of which the
- location is stored in the application's configuration file :
- </example>
- <code lang="C#">
- using log4net.Config;
- using System.IO;
- using System.Configuration;
-
- ...
-
- XmlConfigurator.Configure(new FileInfo(ConfigurationSettings.AppSettings["log4net-config-file"]));
- </code>
- <para>
- In the <c>.config</c> file, the path to the log4net can be specified like this :
- </para>
- <code lang="XML" escaped="true">
- <configuration>
- <appSettings>
- <add key="log4net-config-file" value="log.config"/>
- </appSettings>
- </configuration>
- </code>
- </remarks>
- </member>
- <member name="M:log4net.Config.XmlConfigurator.Configure(System.Uri)">
- <summary>
- Configures log4net using the specified configuration URI.
- </summary>
- <param name="configUri">A URI to load the XML configuration from.</param>
- <remarks>
- <para>
- The configuration data must be valid XML. It must contain
- at least one element called <c>log4net</c> that holds
- the log4net configuration data.
- </para>
- <para>
- The <see cref="T:System.Net.WebRequest"/> must support the URI scheme specified.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Config.XmlConfigurator.Configure(System.IO.Stream)">
- <summary>
- Configures log4net using the specified configuration data stream.
- </summary>
- <param name="configStream">A stream to load the XML configuration from.</param>
- <remarks>
- <para>
- The configuration data must be valid XML. It must contain
- at least one element called <c>log4net</c> that holds
- the log4net configuration data.
- </para>
- <para>
- Note that this method will NOT close the stream parameter.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Config.XmlConfigurator.Configure(log4net.Repository.ILoggerRepository,System.IO.FileInfo)">
- <summary>
- Configures the <see cref="T:log4net.Repository.ILoggerRepository"/> using the specified configuration
- file.
- </summary>
- <param name="repository">The repository to configure.</param>
- <param name="configFile">The XML file to load the configuration from.</param>
- <remarks>
- <para>
- The configuration file must be valid XML. It must contain
- at least one element called <c>log4net</c> that holds
- the configuration data.
- </para>
- <para>
- The log4net configuration file can possible be specified in the application's
- configuration file (either <c>MyAppName.exe.config</c> for a
- normal application on <c>Web.config</c> for an ASP.NET application).
- </para>
- <para>
- The first element matching <c><configuration></c> will be read as the
- configuration. If this file is also a .NET .config file then you must specify
- a configuration section for the <c>log4net</c> element otherwise .NET will
- complain. Set the type for the section handler to <see cref="T:System.Configuration.IgnoreSectionHandler"/>, for example:
- <code lang="XML" escaped="true">
- <configSections>
- <section name="log4net" type="System.Configuration.IgnoreSectionHandler"/>
- </configSections>
- </code>
- </para>
- <example>
- The following example configures log4net using a configuration file, of which the
- location is stored in the application's configuration file :
- </example>
- <code lang="C#">
- using log4net.Config;
- using System.IO;
- using System.Configuration;
-
- ...
-
- XmlConfigurator.Configure(new FileInfo(ConfigurationSettings.AppSettings["log4net-config-file"]));
- </code>
- <para>
- In the <c>.config</c> file, the path to the log4net can be specified like this :
- </para>
- <code lang="XML" escaped="true">
- <configuration>
- <appSettings>
- <add key="log4net-config-file" value="log.config"/>
- </appSettings>
- </configuration>
- </code>
- </remarks>
- </member>
- <member name="M:log4net.Config.XmlConfigurator.Configure(log4net.Repository.ILoggerRepository,System.Uri)">
- <summary>
- Configures the <see cref="T:log4net.Repository.ILoggerRepository"/> using the specified configuration
- URI.
- </summary>
- <param name="repository">The repository to configure.</param>
- <param name="configUri">A URI to load the XML configuration from.</param>
- <remarks>
- <para>
- The configuration data must be valid XML. It must contain
- at least one element called <c>log4net</c> that holds
- the configuration data.
- </para>
- <para>
- The <see cref="T:System.Net.WebRequest"/> must support the URI scheme specified.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Config.XmlConfigurator.Configure(log4net.Repository.ILoggerRepository,System.IO.Stream)">
- <summary>
- Configures the <see cref="T:log4net.Repository.ILoggerRepository"/> using the specified configuration
- file.
- </summary>
- <param name="repository">The repository to configure.</param>
- <param name="configStream">The stream to load the XML configuration from.</param>
- <remarks>
- <para>
- The configuration data must be valid XML. It must contain
- at least one element called <c>log4net</c> that holds
- the configuration data.
- </para>
- <para>
- Note that this method will NOT close the stream parameter.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Config.XmlConfigurator.ConfigureAndWatch(System.IO.FileInfo)">
- <summary>
- Configures log4net using the file specified, monitors the file for changes
- and reloads the configuration if a change is detected.
- </summary>
- <param name="configFile">The XML file to load the configuration from.</param>
- <remarks>
- <para>
- The configuration file must be valid XML. It must contain
- at least one element called <c>log4net</c> that holds
- the configuration data.
- </para>
- <para>
- The configuration file will be monitored using a <see cref="T:System.IO.FileSystemWatcher"/>
- and depends on the behavior of that class.
- </para>
- <para>
- For more information on how to configure log4net using
- a separate configuration file, see <see cref="M:Configure(FileInfo)"/>.
- </para>
- </remarks>
- <seealso cref="M:Configure(FileInfo)"/>
- </member>
- <member name="M:log4net.Config.XmlConfigurator.ConfigureAndWatch(log4net.Repository.ILoggerRepository,System.IO.FileInfo)">
- <summary>
- Configures the <see cref="T:log4net.Repository.ILoggerRepository"/> using the file specified,
- monitors the file for changes and reloads the configuration if a change
- is detected.
- </summary>
- <param name="repository">The repository to configure.</param>
- <param name="configFile">The XML file to load the configuration from.</param>
- <remarks>
- <para>
- The configuration file must be valid XML. It must contain
- at least one element called <c>log4net</c> that holds
- the configuration data.
- </para>
- <para>
- The configuration file will be monitored using a <see cref="T:System.IO.FileSystemWatcher"/>
- and depends on the behavior of that class.
- </para>
- <para>
- For more information on how to configure log4net using
- a separate configuration file, see <see cref="M:Configure(FileInfo)"/>.
- </para>
- </remarks>
- <seealso cref="M:Configure(FileInfo)"/>
- </member>
- <member name="M:log4net.Config.XmlConfigurator.InternalConfigureFromXml(log4net.Repository.ILoggerRepository,System.Xml.XmlElement)">
- <summary>
- Configures the specified repository using a <c>log4net</c> element.
- </summary>
- <param name="repository">The hierarchy to configure.</param>
- <param name="element">The element to parse.</param>
- <remarks>
- <para>
- Loads the log4net configuration from the XML element
- supplied as <paramref name="element"/>.
- </para>
- <para>
- This method is ultimately called by one of the Configure methods
- to load the configuration from an <see cref="T:System.Xml.XmlElement"/>.
- </para>
- </remarks>
- </member>
- <member name="F:log4net.Config.XmlConfigurator.m_repositoryName2ConfigAndWatchHandler">
- <summary>
- Maps repository names to ConfigAndWatchHandler instances to allow a particular
- ConfigAndWatchHandler to dispose of its FileSystemWatcher when a repository is
- reconfigured.
- </summary>
- </member>
- <member name="F:log4net.Config.XmlConfigurator.declaringType">
- <summary>
- The fully qualified type of the XmlConfigurator class.
- </summary>
- <remarks>
- Used by the internal logger to record the Type of the
- log message.
- </remarks>
- </member>
- <member name="T:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler">
- <summary>
- Class used to watch config files.
- </summary>
- <remarks>
- <para>
- Uses the <see cref="T:System.IO.FileSystemWatcher"/> to monitor
- changes to a specified file. Because multiple change notifications
- may be raised when the file is modified, a timer is used to
- compress the notifications into a single event. The timer
- waits for <see cref="F:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler.TimeoutMillis"/> time before delivering
- the event notification. If any further <see cref="T:System.IO.FileSystemWatcher"/>
- change notifications arrive while the timer is waiting it
- is reset and waits again for <see cref="F:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler.TimeoutMillis"/> to
- elapse.
- </para>
- </remarks>
- </member>
- <member name="F:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler.TimeoutMillis">
- <summary>
- The default amount of time to wait after receiving notification
- before reloading the config file.
- </summary>
- </member>
- <member name="F:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler.m_configFile">
- <summary>
- Holds the FileInfo used to configure the XmlConfigurator
- </summary>
- </member>
- <member name="F:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler.m_repository">
- <summary>
- Holds the repository being configured.
- </summary>
- </member>
- <member name="F:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler.m_timer">
- <summary>
- The timer used to compress the notification events.
- </summary>
- </member>
- <member name="F:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler.m_watcher">
- <summary>
- Watches file for changes. This object should be disposed when no longer
- needed to free system handles on the watched resources.
- </summary>
- </member>
- <member name="M:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler.#ctor(log4net.Repository.ILoggerRepository,System.IO.FileInfo)">
- <summary>
- Initializes a new instance of the <see cref="T:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler"/> class to
- watch a specified config file used to configure a repository.
- </summary>
- <param name="repository">The repository to configure.</param>
- <param name="configFile">The configuration file to watch.</param>
- <remarks>
- <para>
- Initializes a new instance of the <see cref="T:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler"/> class.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler.ConfigureAndWatchHandler_OnChanged(System.Object,System.IO.FileSystemEventArgs)">
- <summary>
- Event handler used by <see cref="T:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler"/>.
- </summary>
- <param name="source">The <see cref="T:System.IO.FileSystemWatcher"/> firing the event.</param>
- <param name="e">The argument indicates the file that caused the event to be fired.</param>
- <remarks>
- <para>
- This handler reloads the configuration from the file when the event is fired.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler.ConfigureAndWatchHandler_OnRenamed(System.Object,System.IO.RenamedEventArgs)">
- <summary>
- Event handler used by <see cref="T:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler"/>.
- </summary>
- <param name="source">The <see cref="T:System.IO.FileSystemWatcher"/> firing the event.</param>
- <param name="e">The argument indicates the file that caused the event to be fired.</param>
- <remarks>
- <para>
- This handler reloads the configuration from the file when the event is fired.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler.OnWatchedFileChange(System.Object)">
- <summary>
- Called by the timer when the configuration has been updated.
- </summary>
- <param name="state">null</param>
- </member>
- <member name="M:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler.Dispose">
- <summary>
- Release the handles held by the watcher and timer.
- </summary>
- </member>
- <member name="T:log4net.Core.CompactRepositorySelector">
- <summary>
- The implementation of the <see cref="T:log4net.Core.IRepositorySelector"/> interface suitable
- for use with the compact framework
- </summary>
- <remarks>
- <para>
- This <see cref="T:log4net.Core.IRepositorySelector"/> implementation is a simple
- mapping between repository name and <see cref="T:log4net.Repository.ILoggerRepository"/>
- object.
- </para>
- <para>
- The .NET Compact Framework 1.0 does not support retrieving assembly
- level attributes therefore unlike the <c>DefaultRepositorySelector</c>
- this selector does not examine the calling assembly for attributes.
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- </member>
- <member name="T:log4net.Core.IRepositorySelector">
- <summary>
- Interface used by the <see cref="T:log4net.LogManager"/> to select the <see cref="T:log4net.Repository.ILoggerRepository"/>.
- </summary>
- <remarks>
- <para>
- The <see cref="T:log4net.LogManager"/> uses a <see cref="T:log4net.Core.IRepositorySelector"/>
- to specify the policy for selecting the correct <see cref="T:log4net.Repository.ILoggerRepository"/>
- to return to the caller.
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- <author>Gert Driesen</author>
- </member>
- <member name="M:log4net.Core.IRepositorySelector.GetRepository(System.Reflection.Assembly)">
- <summary>
- Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> for the specified assembly.
- </summary>
- <param name="assembly">The assembly to use to lookup to the <see cref="T:log4net.Repository.ILoggerRepository"/></param>
- <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> for the assembly.</returns>
- <remarks>
- <para>
- Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> for the specified assembly.
- </para>
- <para>
- How the association between <see cref="T:System.Reflection.Assembly"/> and <see cref="T:log4net.Repository.ILoggerRepository"/>
- is made is not defined. The implementation may choose any method for
- this association. The results of this method must be repeatable, i.e.
- when called again with the same arguments the result must be the
- save value.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Core.IRepositorySelector.GetRepository(System.String)">
- <summary>
- Gets the named <see cref="T:log4net.Repository.ILoggerRepository"/>.
- </summary>
- <param name="repositoryName">The name to use to lookup to the <see cref="T:log4net.Repository.ILoggerRepository"/>.</param>
- <returns>The named <see cref="T:log4net.Repository.ILoggerRepository"/></returns>
- <remarks>
- Lookup a named <see cref="T:log4net.Repository.ILoggerRepository"/>. This is the repository created by
- calling <see cref="M:CreateRepository(string,Type)"/>.
- </remarks>
- </member>
- <member name="M:log4net.Core.IRepositorySelector.CreateRepository(System.Reflection.Assembly,System.Type)">
- <summary>
- Creates a new repository for the assembly specified.
- </summary>
- <param name="assembly">The assembly to use to create the domain to associate with the <see cref="T:log4net.Repository.ILoggerRepository"/>.</param>
- <param name="repositoryType">The type of repository to create, must implement <see cref="T:log4net.Repository.ILoggerRepository"/>.</param>
- <returns>The repository created.</returns>
- <remarks>
- <para>
- The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be associated with the domain
- specified such that a call to <see cref="M:GetRepository(Assembly)"/> with the
- same assembly specified will return the same repository instance.
- </para>
- <para>
- How the association between <see cref="T:System.Reflection.Assembly"/> and <see cref="T:log4net.Repository.ILoggerRepository"/>
- is made is not defined. The implementation may choose any method for
- this association.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Core.IRepositorySelector.CreateRepository(System.String,System.Type)">
- <summary>
- Creates a new repository with the name specified.
- </summary>
- <param name="repositoryName">The name to associate with the <see cref="T:log4net.Repository.ILoggerRepository"/>.</param>
- <param name="repositoryType">The type of repository to create, must implement <see cref="T:log4net.Repository.ILoggerRepository"/>.</param>
- <returns>The repository created.</returns>
- <remarks>
- <para>
- The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be associated with the name
- specified such that a call to <see cref="M:GetRepository(string)"/> with the
- same name will return the same repository instance.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Core.IRepositorySelector.ExistsRepository(System.String)">
- <summary>
- Test if a named repository exists
- </summary>
- <param name="repositoryName">the named repository to check</param>
- <returns><c>true</c> if the repository exists</returns>
- <remarks>
- <para>
- Test if a named repository exists. Use <see cref="M:CreateRepository(Assembly, Type)"/>
- to create a new repository and <see cref="M:GetRepository(Assembly)"/> to retrieve
- a repository.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Core.IRepositorySelector.GetAllRepositories">
- <summary>
- Gets an array of all currently defined repositories.
- </summary>
- <returns>
- An array of the <see cref="T:log4net.Repository.ILoggerRepository"/> instances created by
- this <see cref="T:log4net.Core.IRepositorySelector"/>.</returns>
- <remarks>
- <para>
- Gets an array of all of the repositories created by this selector.
- </para>
- </remarks>
- </member>
- <member name="E:log4net.Core.IRepositorySelector.LoggerRepositoryCreatedEvent">
- <summary>
- Event to notify that a logger repository has been created.
- </summary>
- <value>
- Event to notify that a logger repository has been created.
- </value>
- <remarks>
- <para>
- Event raised when a new repository is created.
- The event source will be this selector. The event args will
- be a <see cref="T:log4net.Core.LoggerRepositoryCreationEventArgs"/> which
- holds the newly created <see cref="T:log4net.Repository.ILoggerRepository"/>.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Core.CompactRepositorySelector.#ctor(System.Type)">
- <summary>
- Create a new repository selector
- </summary>
- <param name="defaultRepositoryType">the type of the repositories to create, must implement <see cref="T:log4net.Repository.ILoggerRepository"/></param>
- <remarks>
- <para>
- Create an new compact repository selector.
- The default type for repositories must be specified,
- an appropriate value would be <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/>.
- </para>
- </remarks>
- <exception cref="T:System.ArgumentNullException">throw if <paramref name="defaultRepositoryType"/> is null</exception>
- <exception cref="T:System.ArgumentOutOfRangeException">throw if <paramref name="defaultRepositoryType"/> does not implement <see cref="T:log4net.Repository.ILoggerRepository"/></exception>
- </member>
- <member name="M:log4net.Core.CompactRepositorySelector.GetRepository(System.Reflection.Assembly)">
- <summary>
- Get the <see cref="T:log4net.Repository.ILoggerRepository"/> for the specified assembly
- </summary>
- <param name="assembly">not used</param>
- <returns>The default <see cref="T:log4net.Repository.ILoggerRepository"/></returns>
- <remarks>
- <para>
- The <paramref name="assembly"/> argument is not used. This selector does not create a
- separate repository for each assembly.
- </para>
- <para>
- As a named repository is not specified the default repository is
- returned. The default repository is named <c>log4net-default-repository</c>.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Core.CompactRepositorySelector.GetRepository(System.String)">
- <summary>
- Get the named <see cref="T:log4net.Repository.ILoggerRepository"/>
- </summary>
- <param name="repositoryName">the name of the repository to lookup</param>
- <returns>The named <see cref="T:log4net.Repository.ILoggerRepository"/></returns>
- <remarks>
- <para>
- Get the named <see cref="T:log4net.Repository.ILoggerRepository"/>. The default
- repository is <c>log4net-default-repository</c>. Other repositories
- must be created using the <see cref="M:CreateRepository(string, Type)"/>.
- If the named repository does not exist an exception is thrown.
- </para>
- </remarks>
- <exception cref="T:System.ArgumentNullException">throw if <paramref name="repositoryName"/> is null</exception>
- <exception cref="T:log4net.Core.LogException">throw if the <paramref name="repositoryName"/> does not exist</exception>
- </member>
- <member name="M:log4net.Core.CompactRepositorySelector.CreateRepository(System.Reflection.Assembly,System.Type)">
- <summary>
- Create a new repository for the assembly specified
- </summary>
- <param name="assembly">not used</param>
- <param name="repositoryType">the type of repository to create, must implement <see cref="T:log4net.Repository.ILoggerRepository"/></param>
- <returns>the repository created</returns>
- <remarks>
- <para>
- The <paramref name="assembly"/> argument is not used. This selector does not create a
- separate repository for each assembly.
- </para>
- <para>
- If the <paramref name="repositoryType"/> is <c>null</c> then the
- default repository type specified to the constructor is used.
- </para>
- <para>
- As a named repository is not specified the default repository is
- returned. The default repository is named <c>log4net-default-repository</c>.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Core.CompactRepositorySelector.CreateRepository(System.String,System.Type)">
- <summary>
- Create a new repository for the repository specified
- </summary>
- <param name="repositoryName">the repository to associate with the <see cref="T:log4net.Repository.ILoggerRepository"/></param>
- <param name="repositoryType">the type of repository to create, must implement <see cref="T:log4net.Repository.ILoggerRepository"/>.
- If this param is null then the default repository type is used.</param>
- <returns>the repository created</returns>
- <remarks>
- <para>
- The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be associated with the repository
- specified such that a call to <see cref="M:GetRepository(string)"/> with the
- same repository specified will return the same repository instance.
- </para>
- <para>
- If the named repository already exists an exception will be thrown.
- </para>
- <para>
- If <paramref name="repositoryType"/> is <c>null</c> then the default
- repository type specified to the constructor is used.
- </para>
- </remarks>
- <exception cref="T:System.ArgumentNullException">throw if <paramref name="repositoryName"/> is null</exception>
- <exception cref="T:log4net.Core.LogException">throw if the <paramref name="repositoryName"/> already exists</exception>
- </member>
- <member name="M:log4net.Core.CompactRepositorySelector.ExistsRepository(System.String)">
- <summary>
- Test if a named repository exists
- </summary>
- <param name="repositoryName">the named repository to check</param>
- <returns><c>true</c> if the repository exists</returns>
- <remarks>
- <para>
- Test if a named repository exists. Use <see cref="M:CreateRepository(string, Type)"/>
- to create a new repository and <see cref="M:GetRepository(string)"/> to retrieve
- a repository.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Core.CompactRepositorySelector.GetAllRepositories">
- <summary>
- Gets a list of <see cref="T:log4net.Repository.ILoggerRepository"/> objects
- </summary>
- <returns>an array of all known <see cref="T:log4net.Repository.ILoggerRepository"/> objects</returns>
- <remarks>
- <para>
- Gets an array of all of the repositories created by this selector.
- </para>
- </remarks>
- </member>
- <member name="F:log4net.Core.CompactRepositorySelector.declaringType">
- <summary>
- The fully qualified type of the CompactRepositorySelector class.
- </summary>
- <remarks>
- Used by the internal logger to record the Type of the
- log message.
- </remarks>
- </member>
- <member name="M:log4net.Core.CompactRepositorySelector.OnLoggerRepositoryCreatedEvent(log4net.Repository.ILoggerRepository)">
- <summary>
- Notify the registered listeners that the repository has been created
- </summary>
- <param name="repository">The repository that has been created</param>
- <remarks>
- <para>
- Raises the <event cref="E:log4net.Core.CompactRepositorySelector.LoggerRepositoryCreatedEvent">LoggerRepositoryCreatedEvent</event>
- event.
- </para>
- </remarks>
- </member>
- <member name="E:log4net.Core.CompactRepositorySelector.LoggerRepositoryCreatedEvent">
- <summary>
- Event to notify that a logger repository has been created.
- </summary>
- <value>
- Event to notify that a logger repository has been created.
- </value>
- <remarks>
- <para>
- Event raised when a new repository is created.
- The event source will be this selector. The event args will
- be a <see cref="T:log4net.Core.LoggerRepositoryCreationEventArgs"/> which
- holds the newly created <see cref="T:log4net.Repository.ILoggerRepository"/>.
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Core.DefaultRepositorySelector">
- <summary>
- The default implementation of the <see cref="T:log4net.Core.IRepositorySelector"/> interface.
- </summary>
- <remarks>
- <para>
- Uses attributes defined on the calling assembly to determine how to
- configure the hierarchy for the repository.
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- <author>Gert Driesen</author>
- </member>
- <member name="M:log4net.Core.DefaultRepositorySelector.#ctor(System.Type)">
- <summary>
- Creates a new repository selector.
- </summary>
- <param name="defaultRepositoryType">The type of the repositories to create, must implement <see cref="T:log4net.Repository.ILoggerRepository"/></param>
- <remarks>
- <para>
- Create an new repository selector.
- The default type for repositories must be specified,
- an appropriate value would be <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/>.
- </para>
- </remarks>
- <exception cref="T:System.ArgumentNullException"><paramref name="defaultRepositoryType"/> is <see langword="null"/>.</exception>
- <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="defaultRepositoryType"/> does not implement <see cref="T:log4net.Repository.ILoggerRepository"/>.</exception>
- </member>
- <member name="M:log4net.Core.DefaultRepositorySelector.GetRepository(System.Reflection.Assembly)">
- <summary>
- Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> for the specified assembly.
- </summary>
- <param name="repositoryAssembly">The assembly use to lookup the <see cref="T:log4net.Repository.ILoggerRepository"/>.</param>
- <remarks>
- <para>
- The type of the <see cref="T:log4net.Repository.ILoggerRepository"/> created and the repository
- to create can be overridden by specifying the <see cref="T:log4net.Config.RepositoryAttribute"/>
- attribute on the <paramref name="repositoryAssembly"/>.
- </para>
- <para>
- The default values are to use the <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/>
- implementation of the <see cref="T:log4net.Repository.ILoggerRepository"/> interface and to use the
- <see cref="P:System.Reflection.AssemblyName.Name"/> as the name of the repository.
- </para>
- <para>
- The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be automatically configured using
- any <see cref="T:log4net.Config.ConfiguratorAttribute"/> attributes defined on
- the <paramref name="repositoryAssembly"/>.
- </para>
- </remarks>
- <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> for the assembly</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="repositoryAssembly"/> is <see langword="null"/>.</exception>
- </member>
- <member name="M:log4net.Core.DefaultRepositorySelector.GetRepository(System.String)">
- <summary>
- Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> for the specified repository.
- </summary>
- <param name="repositoryName">The repository to use to lookup the <see cref="T:log4net.Repository.ILoggerRepository"/>.</param>
- <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> for the specified repository.</returns>
- <remarks>
- <para>
- Returns the named repository. If <paramref name="repositoryName"/> is <c>null</c>
- a <see cref="T:System.ArgumentNullException"/> is thrown. If the repository
- does not exist a <see cref="T:log4net.Core.LogException"/> is thrown.
- </para>
- <para>
- Use <see cref="M:CreateRepository(string, Type)"/> to create a repository.
- </para>
- </remarks>
- <exception cref="T:System.ArgumentNullException"><paramref name="repositoryName"/> is <see langword="null"/>.</exception>
- <exception cref="T:log4net.Core.LogException"><paramref name="repositoryName"/> does not exist.</exception>
- </member>
- <member name="M:log4net.Core.DefaultRepositorySelector.CreateRepository(System.Reflection.Assembly,System.Type)">
- <summary>
- Create a new repository for the assembly specified
- </summary>
- <param name="repositoryAssembly">the assembly to use to create the repository to associate with the <see cref="T:log4net.Repository.ILoggerRepository"/>.</param>
- <param name="repositoryType">The type of repository to create, must implement <see cref="T:log4net.Repository.ILoggerRepository"/>.</param>
- <returns>The repository created.</returns>
- <remarks>
- <para>
- The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be associated with the repository
- specified such that a call to <see cref="M:GetRepository(Assembly)"/> with the
- same assembly specified will return the same repository instance.
- </para>
- <para>
- The type of the <see cref="T:log4net.Repository.ILoggerRepository"/> created and
- the repository to create can be overridden by specifying the
- <see cref="T:log4net.Config.RepositoryAttribute"/> attribute on the
- <paramref name="repositoryAssembly"/>. The default values are to use the
- <paramref name="repositoryType"/> implementation of the
- <see cref="T:log4net.Repository.ILoggerRepository"/> interface and to use the
- <see cref="P:System.Reflection.AssemblyName.Name"/> as the name of the repository.
- </para>
- <para>
- The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be automatically
- configured using any <see cref="T:log4net.Config.ConfiguratorAttribute"/>
- attributes defined on the <paramref name="repositoryAssembly"/>.
- </para>
- <para>
- If a repository for the <paramref name="repositoryAssembly"/> already exists
- that repository will be returned. An error will not be raised and that
- repository may be of a different type to that specified in <paramref name="repositoryType"/>.
- Also the <see cref="T:log4net.Config.RepositoryAttribute"/> attribute on the
- assembly may be used to override the repository type specified in
- <paramref name="repositoryType"/>.
- </para>
- </remarks>
- <exception cref="T:System.ArgumentNullException"><paramref name="repositoryAssembly"/> is <see langword="null"/>.</exception>
- </member>
- <member name="M:log4net.Core.DefaultRepositorySelector.CreateRepository(System.Reflection.Assembly,System.Type,System.String,System.Boolean)">
- <summary>
- Creates a new repository for the assembly specified.
- </summary>
- <param name="repositoryAssembly">the assembly to use to create the repository to associate with the <see cref="T:log4net.Repository.ILoggerRepository"/>.</param>
- <param name="repositoryType">The type of repository to create, must implement <see cref="T:log4net.Repository.ILoggerRepository"/>.</param>
- <param name="repositoryName">The name to assign to the created repository</param>
- <param name="readAssemblyAttributes">Set to <c>true</c> to read and apply the assembly attributes</param>
- <returns>The repository created.</returns>
- <remarks>
- <para>
- The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be associated with the repository
- specified such that a call to <see cref="M:GetRepository(Assembly)"/> with the
- same assembly specified will return the same repository instance.
- </para>
- <para>
- The type of the <see cref="T:log4net.Repository.ILoggerRepository"/> created and
- the repository to create can be overridden by specifying the
- <see cref="T:log4net.Config.RepositoryAttribute"/> attribute on the
- <paramref name="repositoryAssembly"/>. The default values are to use the
- <paramref name="repositoryType"/> implementation of the
- <see cref="T:log4net.Repository.ILoggerRepository"/> interface and to use the
- <see cref="P:System.Reflection.AssemblyName.Name"/> as the name of the repository.
- </para>
- <para>
- The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be automatically
- configured using any <see cref="T:log4net.Config.ConfiguratorAttribute"/>
- attributes defined on the <paramref name="repositoryAssembly"/>.
- </para>
- <para>
- If a repository for the <paramref name="repositoryAssembly"/> already exists
- that repository will be returned. An error will not be raised and that
- repository may be of a different type to that specified in <paramref name="repositoryType"/>.
- Also the <see cref="T:log4net.Config.RepositoryAttribute"/> attribute on the
- assembly may be used to override the repository type specified in
- <paramref name="repositoryType"/>.
- </para>
- </remarks>
- <exception cref="T:System.ArgumentNullException"><paramref name="repositoryAssembly"/> is <see langword="null"/>.</exception>
- </member>
- <member name="M:log4net.Core.DefaultRepositorySelector.CreateRepository(System.String,System.Type)">
- <summary>
- Creates a new repository for the specified repository.
- </summary>
- <param name="repositoryName">The repository to associate with the <see cref="T:log4net.Repository.ILoggerRepository"/>.</param>
- <param name="repositoryType">The type of repository to create, must implement <see cref="T:log4net.Repository.ILoggerRepository"/>.
- If this param is <see langword="null"/> then the default repository type is used.</param>
- <returns>The new repository.</returns>
- <remarks>
- <para>
- The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be associated with the repository
- specified such that a call to <see cref="M:GetRepository(string)"/> with the
- same repository specified will return the same repository instance.
- </para>
- </remarks>
- <exception cref="T:System.ArgumentNullException"><paramref name="repositoryName"/> is <see langword="null"/>.</exception>
- <exception cref="T:log4net.Core.LogException"><paramref name="repositoryName"/> already exists.</exception>
- </member>
- <member name="M:log4net.Core.DefaultRepositorySelector.ExistsRepository(System.String)">
- <summary>
- Test if a named repository exists
- </summary>
- <param name="repositoryName">the named repository to check</param>
- <returns><c>true</c> if the repository exists</returns>
- <remarks>
- <para>
- Test if a named repository exists. Use <see cref="M:CreateRepository(string, Type)"/>
- to create a new repository and <see cref="M:GetRepository(string)"/> to retrieve
- a repository.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Core.DefaultRepositorySelector.GetAllRepositories">
- <summary>
- Gets a list of <see cref="T:log4net.Repository.ILoggerRepository"/> objects
- </summary>
- <returns>an array of all known <see cref="T:log4net.Repository.ILoggerRepository"/> objects</returns>
- <remarks>
- <para>
- Gets an array of all of the repositories created by this selector.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Core.DefaultRepositorySelector.AliasRepository(System.String,log4net.Repository.ILoggerRepository)">
- <summary>
- Aliases a repository to an existing repository.
- </summary>
- <param name="repositoryAlias">The repository to alias.</param>
- <param name="repositoryTarget">The repository that the repository is aliased to.</param>
- <remarks>
- <para>
- The repository specified will be aliased to the repository when created.
- The repository must not already exist.
- </para>
- <para>
- When the repository is created it must utilize the same repository type as
- the repository it is aliased to, otherwise the aliasing will fail.
- </para>
- </remarks>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="repositoryAlias"/> is <see langword="null"/>.</para>
- <para>-or-</para>
- <para><paramref name="repositoryTarget"/> is <see langword="null"/>.</para>
- </exception>
- </member>
- <member name="M:log4net.Core.DefaultRepositorySelector.OnLoggerRepositoryCreatedEvent(log4net.Repository.ILoggerRepository)">
- <summary>
- Notifies the registered listeners that the repository has been created.
- </summary>
- <param name="repository">The repository that has been created.</param>
- <remarks>
- <para>
- Raises the <see cref="E:log4net.Core.DefaultRepositorySelector.LoggerRepositoryCreatedEvent"/> event.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Core.DefaultRepositorySelector.GetInfoForAssembly(System.Reflection.Assembly,System.String@,System.Type@)">
- <summary>
- Gets the repository name and repository type for the specified assembly.
- </summary>
- <param name="assembly">The assembly that has a <see cref="T:log4net.Config.RepositoryAttribute"/>.</param>
- <param name="repositoryName">in/out param to hold the repository name to use for the assembly, caller should set this to the default value before calling.</param>
- <param name="repositoryType">in/out param to hold the type of the repository to create for the assembly, caller should set this to the default value before calling.</param>
- <exception cref="T:System.ArgumentNullException"><paramref name="assembly"/> is <see langword="null"/>.</exception>
- </member>
- <member name="M:log4net.Core.DefaultRepositorySelector.ConfigureRepository(System.Reflection.Assembly,log4net.Repository.ILoggerRepository)">
- <summary>
- Configures the repository using information from the assembly.
- </summary>
- <param name="assembly">The assembly containing <see cref="T:log4net.Config.ConfiguratorAttribute"/>
- attributes which define the configuration for the repository.</param>
- <param name="repository">The repository to configure.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="assembly"/> is <see langword="null"/>.</para>
- <para>-or-</para>
- <para><paramref name="repository"/> is <see langword="null"/>.</para>
- </exception>
- </member>
- <member name="M:log4net.Core.DefaultRepositorySelector.LoadPlugins(System.Reflection.Assembly,log4net.Repository.ILoggerRepository)">
- <summary>
- Loads the attribute defined plugins on the assembly.
- </summary>
- <param name="assembly">The assembly that contains the attributes.</param>
- <param name="repository">The repository to add the plugins to.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="assembly"/> is <see langword="null"/>.</para>
- <para>-or-</para>
- <para><paramref name="repository"/> is <see langword="null"/>.</para>
- </exception>
- </member>
- <member name="M:log4net.Core.DefaultRepositorySelector.LoadAliases(System.Reflection.Assembly,log4net.Repository.ILoggerRepository)">
- <summary>
- Loads the attribute defined aliases on the assembly.
- </summary>
- <param name="assembly">The assembly that contains the attributes.</param>
- <param name="repository">The repository to alias to.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="assembly"/> is <see langword="null"/>.</para>
- <para>-or-</para>
- <para><paramref name="repository"/> is <see langword="null"/>.</para>
- </exception>
- </member>
- <member name="F:log4net.Core.DefaultRepositorySelector.declaringType">
- <summary>
- The fully qualified type of the DefaultRepositorySelector class.
- </summary>
- <remarks>
- Used by the internal logger to record the Type of the
- log message.
- </remarks>
- </member>
- <member name="E:log4net.Core.DefaultRepositorySelector.LoggerRepositoryCreatedEvent">
- <summary>
- Event to notify that a logger repository has been created.
- </summary>
- <value>
- Event to notify that a logger repository has been created.
- </value>
- <remarks>
- <para>
- Event raised when a new repository is created.
- The event source will be this selector. The event args will
- be a <see cref="T:log4net.Core.LoggerRepositoryCreationEventArgs"/> which
- holds the newly created <see cref="T:log4net.Repository.ILoggerRepository"/>.
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Core.ErrorCode">
- <summary>
- Defined error codes that can be passed to the <see cref="M:IErrorHandler.Error(string, Exception, ErrorCode)"/> method.
- </summary>
- <remarks>
- <para>
- Values passed to the <see cref="M:IErrorHandler.Error(string, Exception, ErrorCode)"/> method.
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- </member>
- <member name="F:log4net.Core.ErrorCode.GenericFailure">
- <summary>
- A general error
- </summary>
- </member>
- <member name="F:log4net.Core.ErrorCode.WriteFailure">
- <summary>
- Error while writing output
- </summary>
- </member>
- <member name="F:log4net.Core.ErrorCode.FlushFailure">
- <summary>
- Failed to flush file
- </summary>
- </member>
- <member name="F:log4net.Core.ErrorCode.CloseFailure">
- <summary>
- Failed to close file
- </summary>
- </member>
- <member name="F:log4net.Core.ErrorCode.FileOpenFailure">
- <summary>
- Unable to open output file
- </summary>
- </member>
- <member name="F:log4net.Core.ErrorCode.MissingLayout">
- <summary>
- No layout specified
- </summary>
- </member>
- <member name="F:log4net.Core.ErrorCode.AddressParseFailure">
- <summary>
- Failed to parse address
- </summary>
- </member>
- <member name="T:log4net.Core.ExceptionEvaluator">
- <summary>
- An evaluator that triggers on an Exception type
- </summary>
- <remarks>
- <para>
- This evaluator will trigger if the type of the Exception
- passed to <see cref="M:IsTriggeringEvent(LoggingEvent)"/>
- is equal to a Type in <see cref="P:log4net.Core.ExceptionEvaluator.ExceptionType"/>. ///
- </para>
- </remarks>
- <author>Drew Schaeffer</author>
- </member>
- <member name="T:log4net.Core.ITriggeringEventEvaluator">
- <summary>
- Test if an <see cref="T:log4net.Core.LoggingEvent"/> triggers an action
- </summary>
- <remarks>
- <para>
- Implementations of this interface allow certain appenders to decide
- when to perform an appender specific action.
- </para>
- <para>
- The action or behavior triggered is defined by the implementation.
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- </member>
- <member name="M:log4net.Core.ITriggeringEventEvaluator.IsTriggeringEvent(log4net.Core.LoggingEvent)">
- <summary>
- Test if this event triggers the action
- </summary>
- <param name="loggingEvent">The event to check</param>
- <returns><c>true</c> if this event triggers the action, otherwise <c>false</c></returns>
- <remarks>
- <para>
- Return <c>true</c> if this event triggers the action
- </para>
- </remarks>
- </member>
- <member name="F:log4net.Core.ExceptionEvaluator.m_type">
- <summary>
- The type that causes the trigger to fire.
- </summary>
- </member>
- <member name="F:log4net.Core.ExceptionEvaluator.m_triggerOnSubclass">
- <summary>
- Causes subclasses of <see cref="P:log4net.Core.ExceptionEvaluator.ExceptionType"/> to cause the trigger to fire.
- </summary>
- </member>
- <member name="M:log4net.Core.ExceptionEvaluator.#ctor">
- <summary>
- Default ctor to allow dynamic creation through a configurator.
- </summary>
- </member>
- <member name="M:log4net.Core.ExceptionEvaluator.#ctor(System.Type,System.Boolean)">
- <summary>
- Constructs an evaluator and initializes to trigger on <paramref name="exType"/>
- </summary>
- <param name="exType">the type that triggers this evaluator.</param>
- <param name="triggerOnSubClass">If true, this evaluator will trigger on subclasses of <see cref="P:log4net.Core.ExceptionEvaluator.ExceptionType"/>.</param>
- </member>
- <member name="M:log4net.Core.ExceptionEvaluator.IsTriggeringEvent(log4net.Core.LoggingEvent)">
- <summary>
- Is this <paramref name="loggingEvent"/> the triggering event?
- </summary>
- <param name="loggingEvent">The event to check</param>
- <returns>This method returns <c>true</c>, if the logging event Exception
- Type is <see cref="P:log4net.Core.ExceptionEvaluator.ExceptionType"/>.
- Otherwise it returns <c>false</c></returns>
- <remarks>
- <para>
- This evaluator will trigger if the Exception Type of the event
- passed to <see cref="M:IsTriggeringEvent(LoggingEvent)"/>
- is <see cref="P:log4net.Core.ExceptionEvaluator.ExceptionType"/>.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Core.ExceptionEvaluator.ExceptionType">
- <summary>
- The type that triggers this evaluator.
- </summary>
- </member>
- <member name="P:log4net.Core.ExceptionEvaluator.TriggerOnSubclass">
- <summary>
- If true, this evaluator will trigger on subclasses of <see cref="P:log4net.Core.ExceptionEvaluator.ExceptionType"/>.
- </summary>
- </member>
- <member name="T:log4net.Core.IErrorHandler">
- <summary>
- Appenders may delegate their error handling to an <see cref="T:log4net.Core.IErrorHandler"/>.
- </summary>
- <remarks>
- <para>
- Error handling is a particularly tedious to get right because by
- definition errors are hard to predict and to reproduce.
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- <author>Gert Driesen</author>
- </member>
- <member name="M:log4net.Core.IErrorHandler.Error(System.String,System.Exception,log4net.Core.ErrorCode)">
- <summary>
- Handles the error and information about the error condition is passed as
- a parameter.
- </summary>
- <param name="message">The message associated with the error.</param>
- <param name="e">The <see cref="T:System.Exception"/> that was thrown when the error occurred.</param>
- <param name="errorCode">The error code associated with the error.</param>
- <remarks>
- <para>
- Handles the error and information about the error condition is passed as
- a parameter.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Core.IErrorHandler.Error(System.String,System.Exception)">
- <summary>
- Prints the error message passed as a parameter.
- </summary>
- <param name="message">The message associated with the error.</param>
- <param name="e">The <see cref="T:System.Exception"/> that was thrown when the error occurred.</param>
- <remarks>
- <para>
- See <see cref="M:Error(string,Exception,ErrorCode)"/>.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Core.IErrorHandler.Error(System.String)">
- <summary>
- Prints the error message passed as a parameter.
- </summary>
- <param name="message">The message associated with the error.</param>
- <remarks>
- <para>
- See <see cref="M:Error(string,Exception,ErrorCode)"/>.
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Core.IFixingRequired">
- <summary>
- Interface for objects that require fixing.
- </summary>
- <remarks>
- <para>
- Interface that indicates that the object requires fixing before it
- can be taken outside the context of the appender's
- <see cref="M:log4net.Appender.IAppender.DoAppend(log4net.Core.LoggingEvent)"/> method.
- </para>
- <para>
- When objects that implement this interface are stored
- in the context properties maps <see cref="T:log4net.GlobalContext"/>
- <see cref="P:log4net.GlobalContext.Properties"/> and <see cref="T:log4net.ThreadContext"/>
- <see cref="P:log4net.ThreadContext.Properties"/> are fixed
- (see <see cref="P:log4net.Core.LoggingEvent.Fix"/>) the <see cref="M:log4net.Core.IFixingRequired.GetFixedObject"/>
- method will be called.
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- </member>
- <member name="M:log4net.Core.IFixingRequired.GetFixedObject">
- <summary>
- Get a portable version of this object
- </summary>
- <returns>the portable instance of this object</returns>
- <remarks>
- <para>
- Get a portable instance object that represents the current
- state of this object. The portable object can be stored
- and logged from any thread with identical results.
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Core.ILogger">
- <summary>
- Interface that all loggers implement
- </summary>
- <remarks>
- <para>
- This interface supports logging events and testing if a level
- is enabled for logging.
- </para>
- <para>
- These methods will not throw exceptions. Note to implementor, ensure
- that the implementation of these methods cannot allow an exception
- to be thrown to the caller.
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- <author>Gert Driesen</author>
- </member>
- <member name="M:log4net.Core.ILogger.Log(System.Type,log4net.Core.Level,System.Object,System.Exception)">
- <summary>
- This generic form is intended to be used by wrappers.
- </summary>
- <param name="callerStackBoundaryDeclaringType">The declaring type of the method that is
- the stack boundary into the logging system for this call.</param>
- <param name="level">The level of the message to be logged.</param>
- <param name="message">The message object to log.</param>
- <param name="exception">the exception to log, including its stack trace. Pass <c>null</c> to not log an exception.</param>
- <remarks>
- <para>
- Generates a logging event for the specified <paramref name="level"/> using
- the <paramref name="message"/> and <paramref name="exception"/>.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Core.ILogger.Log(log4net.Core.LoggingEvent)">
- <summary>
- This is the most generic printing method that is intended to be used
- by wrappers.
- </summary>
- <param name="logEvent">The event being logged.</param>
- <remarks>
- <para>
- Logs the specified logging event through this logger.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Core.ILogger.IsEnabledFor(log4net.Core.Level)">
- <summary>
- Checks if this logger is enabled for a given <see cref="T:log4net.Core.Level"/> passed as parameter.
- </summary>
- <param name="level">The level to check.</param>
- <returns>
- <c>true</c> if this logger is enabled for <c>level</c>, otherwise <c>false</c>.
- </returns>
- <remarks>
- <para>
- Test if this logger is going to log events of the specified <paramref name="level"/>.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Core.ILogger.Name">
- <summary>
- Gets the name of the logger.
- </summary>
- <value>
- The name of the logger.
- </value>
- <remarks>
- <para>
- The name of this logger
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Core.ILogger.Repository">
- <summary>
- Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> where this
- <c>Logger</c> instance is attached to.
- </summary>
- <value>
- The <see cref="T:log4net.Repository.ILoggerRepository"/> that this logger belongs to.
- </value>
- <remarks>
- <para>
- Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> where this
- <c>Logger</c> instance is attached to.
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Core.ILoggerWrapper">
- <summary>
- Base interface for all wrappers
- </summary>
- <remarks>
- <para>
- Base interface for all wrappers.
- </para>
- <para>
- All wrappers must implement this interface.
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- </member>
- <member name="P:log4net.Core.ILoggerWrapper.Logger">
- <summary>
- Get the implementation behind this wrapper object.
- </summary>
- <value>
- The <see cref="T:log4net.Core.ILogger"/> object that in implementing this object.
- </value>
- <remarks>
- <para>
- The <see cref="T:log4net.Core.ILogger"/> object that in implementing this
- object. The <c>Logger</c> object may not
- be the same object as this object because of logger decorators.
- This gets the actual underlying objects that is used to process
- the log events.
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Core.LoggerRepositoryCreationEventHandler">
- <summary>
- Delegate used to handle logger repository creation event notifications
- </summary>
- <param name="sender">The <see cref="T:log4net.Core.IRepositorySelector"/> which created the repository.</param>
- <param name="e">The <see cref="T:log4net.Core.LoggerRepositoryCreationEventArgs"/> event args
- that holds the <see cref="T:log4net.Repository.ILoggerRepository"/> instance that has been created.</param>
- <remarks>
- <para>
- Delegate used to handle logger repository creation event notifications.
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Core.LoggerRepositoryCreationEventArgs">
- <summary>
- Provides data for the <see cref="E:log4net.Core.IRepositorySelector.LoggerRepositoryCreatedEvent"/> event.
- </summary>
- <remarks>
- <para>
- A <see cref="E:log4net.Core.IRepositorySelector.LoggerRepositoryCreatedEvent"/>
- event is raised every time a <see cref="T:log4net.Repository.ILoggerRepository"/> is created.
- </para>
- </remarks>
- </member>
- <member name="F:log4net.Core.LoggerRepositoryCreationEventArgs.m_repository">
- <summary>
- The <see cref="T:log4net.Repository.ILoggerRepository"/> created
- </summary>
- </member>
- <member name="M:log4net.Core.LoggerRepositoryCreationEventArgs.#ctor(log4net.Repository.ILoggerRepository)">
- <summary>
- Construct instance using <see cref="T:log4net.Repository.ILoggerRepository"/> specified
- </summary>
- <param name="repository">the <see cref="T:log4net.Repository.ILoggerRepository"/> that has been created</param>
- <remarks>
- <para>
- Construct instance using <see cref="T:log4net.Repository.ILoggerRepository"/> specified
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Core.LoggerRepositoryCreationEventArgs.LoggerRepository">
- <summary>
- The <see cref="T:log4net.Repository.ILoggerRepository"/> that has been created
- </summary>
- <value>
- The <see cref="T:log4net.Repository.ILoggerRepository"/> that has been created
- </value>
- <remarks>
- <para>
- The <see cref="T:log4net.Repository.ILoggerRepository"/> that has been created
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Core.Level">
- <summary>
- Defines the default set of levels recognized by the system.
- </summary>
- <remarks>
- <para>
- Each <see cref="T:log4net.Core.LoggingEvent"/> has an associated <see cref="T:log4net.Core.Level"/>.
- </para>
- <para>
- Levels have a numeric <see cref="P:log4net.Core.Level.Value"/> that defines the relative
- ordering between levels. Two Levels with the same <see cref="P:log4net.Core.Level.Value"/>
- are deemed to be equivalent.
- </para>
- <para>
- The levels that are recognized by log4net are set for each <see cref="T:log4net.Repository.ILoggerRepository"/>
- and each repository can have different levels defined. The levels are stored
- in the <see cref="P:log4net.Repository.ILoggerRepository.LevelMap"/> on the repository. Levels are
- looked up by name from the <see cref="P:log4net.Repository.ILoggerRepository.LevelMap"/>.
- </para>
- <para>
- When logging at level INFO the actual level used is not <see cref="F:log4net.Core.Level.Info"/> but
- the value of <c>LoggerRepository.LevelMap["INFO"]</c>. The default value for this is
- <see cref="F:log4net.Core.Level.Info"/>, but this can be changed by reconfiguring the level map.
- </para>
- <para>
- Each level has a <see cref="P:log4net.Core.Level.DisplayName"/> in addition to its <see cref="P:log4net.Core.Level.Name"/>. The
- <see cref="P:log4net.Core.Level.DisplayName"/> is the string that is written into the output log. By default
- the display name is the same as the level name, but this can be used to alias levels
- or to localize the log output.
- </para>
- <para>
- Some of the predefined levels recognized by the system are:
- </para>
- <list type="bullet">
- <item>
- <description><see cref="F:log4net.Core.Level.Off"/>.</description>
- </item>
- <item>
- <description><see cref="F:log4net.Core.Level.Fatal"/>.</description>
- </item>
- <item>
- <description><see cref="F:log4net.Core.Level.Error"/>.</description>
- </item>
- <item>
- <description><see cref="F:log4net.Core.Level.Warn"/>.</description>
- </item>
- <item>
- <description><see cref="F:log4net.Core.Level.Info"/>.</description>
- </item>
- <item>
- <description><see cref="F:log4net.Core.Level.Debug"/>.</description>
- </item>
- <item>
- <description><see cref="F:log4net.Core.Level.All"/>.</description>
- </item>
- </list>
- </remarks>
- <author>Nicko Cadell</author>
- <author>Gert Driesen</author>
- </member>
- <member name="M:log4net.Core.Level.#ctor(System.Int32,System.String,System.String)">
- <summary>
- Constructor
- </summary>
- <param name="level">Integer value for this level, higher values represent more severe levels.</param>
- <param name="levelName">The string name of this level.</param>
- <param name="displayName">The display name for this level. This may be localized or otherwise different from the name</param>
- <remarks>
- <para>
- Initializes a new instance of the <see cref="T:log4net.Core.Level"/> class with
- the specified level name and value.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Core.Level.#ctor(System.Int32,System.String)">
- <summary>
- Constructor
- </summary>
- <param name="level">Integer value for this level, higher values represent more severe levels.</param>
- <param name="levelName">The string name of this level.</param>
- <remarks>
- <para>
- Initializes a new instance of the <see cref="T:log4net.Core.Level"/> class with
- the specified level name and value.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Core.Level.ToString">
- <summary>
- Returns the <see cref="T:System.String"/> representation of the current
- <see cref="T:log4net.Core.Level"/>.
- </summary>
- <returns>
- A <see cref="T:System.String"/> representation of the current <see cref="T:log4net.Core.Level"/>.
- </returns>
- <remarks>
- <para>
- Returns the level <see cref="P:log4net.Core.Level.Name"/>.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Core.Level.Equals(System.Object)">
- <summary>
- Compares levels.
- </summary>
- <param name="o">The object to compare against.</param>
- <returns><c>true</c> if the objects are equal.</returns>
- <remarks>
- <para>
- Compares the levels of <see cref="T:log4net.Core.Level"/> instances, and
- defers to base class if the target object is not a <see cref="T:log4net.Core.Level"/>
- instance.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Core.Level.GetHashCode">
- <summary>
- Returns a hash code
- </summary>
- <returns>A hash code for the current <see cref="T:log4net.Core.Level"/>.</returns>
- <remarks>
- <para>
- Returns a hash code suitable for use in hashing algorithms and data
- structures like a hash table.
- </para>
- <para>
- Returns the hash code of the level <see cref="P:log4net.Core.Level.Value"/>.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Core.Level.CompareTo(System.Object)">
- <summary>
- Compares this instance to a specified object and returns an
- indication of their relative values.
- </summary>
- <param name="r">A <see cref="T:log4net.Core.Level"/> instance or <see langword="null"/> to compare with this instance.</param>
- <returns>
- A 32-bit signed integer that indicates the relative order of the
- values compared. The return value has these meanings:
- <list type="table">
- <listheader>
- <term>Value</term>
- <description>Meaning</description>
- </listheader>
- <item>
- <term>Less than zero</term>
- <description>This instance is less than <paramref name="r"/>.</description>
- </item>
- <item>
- <term>Zero</term>
- <description>This instance is equal to <paramref name="r"/>.</description>
- </item>
- <item>
- <term>Greater than zero</term>
- <description>
- <para>This instance is greater than <paramref name="r"/>.</para>
- <para>-or-</para>
- <para><paramref name="r"/> is <see langword="null"/>.</para>
- </description>
- </item>
- </list>
- </returns>
- <remarks>
- <para>
- <paramref name="r"/> must be an instance of <see cref="T:log4net.Core.Level"/>
- or <see langword="null"/>; otherwise, an exception is thrown.
- </para>
- </remarks>
- <exception cref="T:System.ArgumentException"><paramref name="r"/> is not a <see cref="T:log4net.Core.Level"/>.</exception>
- </member>
- <member name="M:log4net.Core.Level.op_GreaterThan(log4net.Core.Level,log4net.Core.Level)">
- <summary>
- Returns a value indicating whether a specified <see cref="T:log4net.Core.Level"/>
- is greater than another specified <see cref="T:log4net.Core.Level"/>.
- </summary>
- <param name="l">A <see cref="T:log4net.Core.Level"/></param>
- <param name="r">A <see cref="T:log4net.Core.Level"/></param>
- <returns>
- <c>true</c> if <paramref name="l"/> is greater than
- <paramref name="r"/>; otherwise, <c>false</c>.
- </returns>
- <remarks>
- <para>
- Compares two levels.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Core.Level.op_LessThan(log4net.Core.Level,log4net.Core.Level)">
- <summary>
- Returns a value indicating whether a specified <see cref="T:log4net.Core.Level"/>
- is less than another specified <see cref="T:log4net.Core.Level"/>.
- </summary>
- <param name="l">A <see cref="T:log4net.Core.Level"/></param>
- <param name="r">A <see cref="T:log4net.Core.Level"/></param>
- <returns>
- <c>true</c> if <paramref name="l"/> is less than
- <paramref name="r"/>; otherwise, <c>false</c>.
- </returns>
- <remarks>
- <para>
- Compares two levels.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Core.Level.op_GreaterThanOrEqual(log4net.Core.Level,log4net.Core.Level)">
- <summary>
- Returns a value indicating whether a specified <see cref="T:log4net.Core.Level"/>
- is greater than or equal to another specified <see cref="T:log4net.Core.Level"/>.
- </summary>
- <param name="l">A <see cref="T:log4net.Core.Level"/></param>
- <param name="r">A <see cref="T:log4net.Core.Level"/></param>
- <returns>
- <c>true</c> if <paramref name="l"/> is greater than or equal to
- <paramref name="r"/>; otherwise, <c>false</c>.
- </returns>
- <remarks>
- <para>
- Compares two levels.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Core.Level.op_LessThanOrEqual(log4net.Core.Level,log4net.Core.Level)">
- <summary>
- Returns a value indicating whether a specified <see cref="T:log4net.Core.Level"/>
- is less than or equal to another specified <see cref="T:log4net.Core.Level"/>.
- </summary>
- <param name="l">A <see cref="T:log4net.Core.Level"/></param>
- <param name="r">A <see cref="T:log4net.Core.Level"/></param>
- <returns>
- <c>true</c> if <paramref name="l"/> is less than or equal to
- <paramref name="r"/>; otherwise, <c>false</c>.
- </returns>
- <remarks>
- <para>
- Compares two levels.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Core.Level.op_Equality(log4net.Core.Level,log4net.Core.Level)">
- <summary>
- Returns a value indicating whether two specified <see cref="T:log4net.Core.Level"/>
- objects have the same value.
- </summary>
- <param name="l">A <see cref="T:log4net.Core.Level"/> or <see langword="null"/>.</param>
- <param name="r">A <see cref="T:log4net.Core.Level"/> or <see langword="null"/>.</param>
- <returns>
- <c>true</c> if the value of <paramref name="l"/> is the same as the
- value of <paramref name="r"/>; otherwise, <c>false</c>.
- </returns>
- <remarks>
- <para>
- Compares two levels.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Core.Level.op_Inequality(log4net.Core.Level,log4net.Core.Level)">
- <summary>
- Returns a value indicating whether two specified <see cref="T:log4net.Core.Level"/>
- objects have different values.
- </summary>
- <param name="l">A <see cref="T:log4net.Core.Level"/> or <see langword="null"/>.</param>
- <param name="r">A <see cref="T:log4net.Core.Level"/> or <see langword="null"/>.</param>
- <returns>
- <c>true</c> if the value of <paramref name="l"/> is different from
- the value of <paramref name="r"/>; otherwise, <c>false</c>.
- </returns>
- <remarks>
- <para>
- Compares two levels.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Core.Level.Compare(log4net.Core.Level,log4net.Core.Level)">
- <summary>
- Compares two specified <see cref="T:log4net.Core.Level"/> instances.
- </summary>
- <param name="l">The first <see cref="T:log4net.Core.Level"/> to compare.</param>
- <param name="r">The second <see cref="T:log4net.Core.Level"/> to compare.</param>
- <returns>
- A 32-bit signed integer that indicates the relative order of the
- two values compared. The return value has these meanings:
- <list type="table">
- <listheader>
- <term>Value</term>
- <description>Meaning</description>
- </listheader>
- <item>
- <term>Less than zero</term>
- <description><paramref name="l"/> is less than <paramref name="r"/>.</description>
- </item>
- <item>
- <term>Zero</term>
- <description><paramref name="l"/> is equal to <paramref name="r"/>.</description>
- </item>
- <item>
- <term>Greater than zero</term>
- <description><paramref name="l"/> is greater than <paramref name="r"/>.</description>
- </item>
- </list>
- </returns>
- <remarks>
- <para>
- Compares two levels.
- </para>
- </remarks>
- </member>
- <member name="F:log4net.Core.Level.Off">
- <summary>
- The <see cref="F:log4net.Core.Level.Off"/> level designates a higher level than all the rest.
- </summary>
- </member>
- <member name="F:log4net.Core.Level.Log4Net_Debug">
- <summary>
- The <see cref="F:log4net.Core.Level.Emergency"/> level designates very severe error events.
- System unusable, emergencies.
- </summary>
- </member>
- <member name="F:log4net.Core.Level.Emergency">
- <summary>
- The <see cref="F:log4net.Core.Level.Emergency"/> level designates very severe error events.
- System unusable, emergencies.
- </summary>
- </member>
- <member name="F:log4net.Core.Level.Fatal">
- <summary>
- The <see cref="F:log4net.Core.Level.Fatal"/> level designates very severe error events
- that will presumably lead the application to abort.
- </summary>
- </member>
- <member name="F:log4net.Core.Level.Alert">
- <summary>
- The <see cref="F:log4net.Core.Level.Alert"/> level designates very severe error events.
- Take immediate action, alerts.
- </summary>
- </member>
- <member name="F:log4net.Core.Level.Critical">
- <summary>
- The <see cref="F:log4net.Core.Level.Critical"/> level designates very severe error events.
- Critical condition, critical.
- </summary>
- </member>
- <member name="F:log4net.Core.Level.Severe">
- <summary>
- The <see cref="F:log4net.Core.Level.Severe"/> level designates very severe error events.
- </summary>
- </member>
- <member name="F:log4net.Core.Level.Error">
- <summary>
- The <see cref="F:log4net.Core.Level.Error"/> level designates error events that might
- still allow the application to continue running.
- </summary>
- </member>
- <member name="F:log4net.Core.Level.Warn">
- <summary>
- The <see cref="F:log4net.Core.Level.Warn"/> level designates potentially harmful
- situations.
- </summary>
- </member>
- <member name="F:log4net.Core.Level.Notice">
- <summary>
- The <see cref="F:log4net.Core.Level.Notice"/> level designates informational messages
- that highlight the progress of the application at the highest level.
- </summary>
- </member>
- <member name="F:log4net.Core.Level.Info">
- <summary>
- The <see cref="F:log4net.Core.Level.Info"/> level designates informational messages that
- highlight the progress of the application at coarse-grained level.
- </summary>
- </member>
- <member name="F:log4net.Core.Level.Debug">
- <summary>
- The <see cref="F:log4net.Core.Level.Debug"/> level designates fine-grained informational
- events that are most useful to debug an application.
- </summary>
- </member>
- <member name="F:log4net.Core.Level.Fine">
- <summary>
- The <see cref="F:log4net.Core.Level.Fine"/> level designates fine-grained informational
- events that are most useful to debug an application.
- </summary>
- </member>
- <member name="F:log4net.Core.Level.Trace">
- <summary>
- The <see cref="F:log4net.Core.Level.Trace"/> level designates fine-grained informational
- events that are most useful to debug an application.
- </summary>
- </member>
- <member name="F:log4net.Core.Level.Finer">
- <summary>
- The <see cref="F:log4net.Core.Level.Finer"/> level designates fine-grained informational
- events that are most useful to debug an application.
- </summary>
- </member>
- <member name="F:log4net.Core.Level.Verbose">
- <summary>
- The <see cref="F:log4net.Core.Level.Verbose"/> level designates fine-grained informational
- events that are most useful to debug an application.
- </summary>
- </member>
- <member name="F:log4net.Core.Level.Finest">
- <summary>
- The <see cref="F:log4net.Core.Level.Finest"/> level designates fine-grained informational
- events that are most useful to debug an application.
- </summary>
- </member>
- <member name="F:log4net.Core.Level.All">
- <summary>
- The <see cref="F:log4net.Core.Level.All"/> level designates the lowest level possible.
- </summary>
- </member>
- <member name="P:log4net.Core.Level.Name">
- <summary>
- Gets the name of this level.
- </summary>
- <value>
- The name of this level.
- </value>
- <remarks>
- <para>
- Gets the name of this level.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Core.Level.Value">
- <summary>
- Gets the value of this level.
- </summary>
- <value>
- The value of this level.
- </value>
- <remarks>
- <para>
- Gets the value of this level.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Core.Level.DisplayName">
- <summary>
- Gets the display name of this level.
- </summary>
- <value>
- The display name of this level.
- </value>
- <remarks>
- <para>
- Gets the display name of this level.
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Core.LevelCollection">
- <summary>
- A strongly-typed collection of <see cref="T:log4net.Core.Level"/> objects.
- </summary>
- <author>Nicko Cadell</author>
- </member>
- <member name="M:log4net.Core.LevelCollection.ReadOnly(log4net.Core.LevelCollection)">
- <summary>
- Creates a read-only wrapper for a <c>LevelCollection</c> instance.
- </summary>
- <param name="list">list to create a readonly wrapper arround</param>
- <returns>
- A <c>LevelCollection</c> wrapper that is read-only.
- </returns>
- </member>
- <member name="M:log4net.Core.LevelCollection.#ctor">
- <summary>
- Initializes a new instance of the <c>LevelCollection</c> class
- that is empty and has the default initial capacity.
- </summary>
- </member>
- <member name="M:log4net.Core.LevelCollection.#ctor(System.Int32)">
- <summary>
- Initializes a new instance of the <c>LevelCollection</c> class
- that has the specified initial capacity.
- </summary>
- <param name="capacity">
- The number of elements that the new <c>LevelCollection</c> is initially capable of storing.
- </param>
- </member>
- <member name="M:log4net.Core.LevelCollection.#ctor(log4net.Core.LevelCollection)">
- <summary>
- Initializes a new instance of the <c>LevelCollection</c> class
- that contains elements copied from the specified <c>LevelCollection</c>.
- </summary>
- <param name="c">The <c>LevelCollection</c> whose elements are copied to the new collection.</param>
- </member>
- <member name="M:log4net.Core.LevelCollection.#ctor(log4net.Core.Level[])">
- <summary>
- Initializes a new instance of the <c>LevelCollection</c> class
- that contains elements copied from the specified <see cref="T:log4net.Core.Level"/> array.
- </summary>
- <param name="a">The <see cref="T:log4net.Core.Level"/> array whose elements are copied to the new list.</param>
- </member>
- <member name="M:log4net.Core.LevelCollection.#ctor(System.Collections.ICollection)">
- <summary>
- Initializes a new instance of the <c>LevelCollection</c> class
- that contains elements copied from the specified <see cref="T:log4net.Core.Level"/> collection.
- </summary>
- <param name="col">The <see cref="T:log4net.Core.Level"/> collection whose elements are copied to the new list.</param>
- </member>
- <member name="M:log4net.Core.LevelCollection.#ctor(log4net.Core.LevelCollection.Tag)">
- <summary>
- Allow subclasses to avoid our default constructors
- </summary>
- <param name="tag"></param>
- </member>
- <member name="M:log4net.Core.LevelCollection.CopyTo(log4net.Core.Level[])">
- <summary>
- Copies the entire <c>LevelCollection</c> to a one-dimensional
- <see cref="T:log4net.Core.Level"/> array.
- </summary>
- <param name="array">The one-dimensional <see cref="T:log4net.Core.Level"/> array to copy to.</param>
- </member>
- <member name="M:log4net.Core.LevelCollection.CopyTo(log4net.Core.Level[],System.Int32)">
- <summary>
- Copies the entire <c>LevelCollection</c> to a one-dimensional
- <see cref="T:log4net.Core.Level"/> array, starting at the specified index of the target array.
- </summary>
- <param name="array">The one-dimensional <see cref="T:log4net.Core.Level"/> array to copy to.</param>
- <param name="start">The zero-based index in <paramref name="array"/> at which copying begins.</param>
- </member>
- <member name="M:log4net.Core.LevelCollection.Add(log4net.Core.Level)">
- <summary>
- Adds a <see cref="T:log4net.Core.Level"/> to the end of the <c>LevelCollection</c>.
- </summary>
- <param name="item">The <see cref="T:log4net.Core.Level"/> to be added to the end of the <c>LevelCollection</c>.</param>
- <returns>The index at which the value has been added.</returns>
- </member>
- <member name="M:log4net.Core.LevelCollection.Clear">
- <summary>
- Removes all elements from the <c>LevelCollection</c>.
- </summary>
- </member>
- <member name="M:log4net.Core.LevelCollection.Clone">
- <summary>
- Creates a shallow copy of the <see cref="T:log4net.Core.LevelCollection"/>.
- </summary>
- <returns>A new <see cref="T:log4net.Core.LevelCollection"/> with a shallow copy of the collection data.</returns>
- </member>
- <member name="M:log4net.Core.LevelCollection.Contains(log4net.Core.Level)">
- <summary>
- Determines whether a given <see cref="T:log4net.Core.Level"/> is in the <c>LevelCollection</c>.
- </summary>
- <param name="item">The <see cref="T:log4net.Core.Level"/> to check for.</param>
- <returns><c>true</c> if <paramref name="item"/> is found in the <c>LevelCollection</c>; otherwise, <c>false</c>.</returns>
- </member>
- <member name="M:log4net.Core.LevelCollection.IndexOf(log4net.Core.Level)">
- <summary>
- Returns the zero-based index of the first occurrence of a <see cref="T:log4net.Core.Level"/>
- in the <c>LevelCollection</c>.
- </summary>
- <param name="item">The <see cref="T:log4net.Core.Level"/> to locate in the <c>LevelCollection</c>.</param>
- <returns>
- The zero-based index of the first occurrence of <paramref name="item"/>
- in the entire <c>LevelCollection</c>, if found; otherwise, -1.
- </returns>
- </member>
- <member name="M:log4net.Core.LevelCollection.Insert(System.Int32,log4net.Core.Level)">
- <summary>
- Inserts an element into the <c>LevelCollection</c> at the specified index.
- </summary>
- <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
- <param name="item">The <see cref="T:log4net.Core.Level"/> to insert.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="index"/> is less than zero</para>
- <para>-or-</para>
- <para><paramref name="index"/> is equal to or greater than <see cref="P:log4net.Core.LevelCollection.Count"/>.</para>
- </exception>
- </member>
- <member name="M:log4net.Core.LevelCollection.Remove(log4net.Core.Level)">
- <summary>
- Removes the first occurrence of a specific <see cref="T:log4net.Core.Level"/> from the <c>LevelCollection</c>.
- </summary>
- <param name="item">The <see cref="T:log4net.Core.Level"/> to remove from the <c>LevelCollection</c>.</param>
- <exception cref="T:System.ArgumentException">
- The specified <see cref="T:log4net.Core.Level"/> was not found in the <c>LevelCollection</c>.
- </exception>
- </member>
- <member name="M:log4net.Core.LevelCollection.RemoveAt(System.Int32)">
- <summary>
- Removes the element at the specified index of the <c>LevelCollection</c>.
- </summary>
- <param name="index">The zero-based index of the element to remove.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="index"/> is less than zero</para>
- <para>-or-</para>
- <para><paramref name="index"/> is equal to or greater than <see cref="P:log4net.Core.LevelCollection.Count"/>.</para>
- </exception>
- </member>
- <member name="M:log4net.Core.LevelCollection.GetEnumerator">
- <summary>
- Returns an enumerator that can iterate through the <c>LevelCollection</c>.
- </summary>
- <returns>An <see cref="T:log4net.Core.LevelCollection.Enumerator"/> for the entire <c>LevelCollection</c>.</returns>
- </member>
- <member name="M:log4net.Core.LevelCollection.AddRange(log4net.Core.LevelCollection)">
- <summary>
- Adds the elements of another <c>LevelCollection</c> to the current <c>LevelCollection</c>.
- </summary>
- <param name="x">The <c>LevelCollection</c> whose elements should be added to the end of the current <c>LevelCollection</c>.</param>
- <returns>The new <see cref="P:log4net.Core.LevelCollection.Count"/> of the <c>LevelCollection</c>.</returns>
- </member>
- <member name="M:log4net.Core.LevelCollection.AddRange(log4net.Core.Level[])">
- <summary>
- Adds the elements of a <see cref="T:log4net.Core.Level"/> array to the current <c>LevelCollection</c>.
- </summary>
- <param name="x">The <see cref="T:log4net.Core.Level"/> array whose elements should be added to the end of the <c>LevelCollection</c>.</param>
- <returns>The new <see cref="P:log4net.Core.LevelCollection.Count"/> of the <c>LevelCollection</c>.</returns>
- </member>
- <member name="M:log4net.Core.LevelCollection.AddRange(System.Collections.ICollection)">
- <summary>
- Adds the elements of a <see cref="T:log4net.Core.Level"/> collection to the current <c>LevelCollection</c>.
- </summary>
- <param name="col">The <see cref="T:log4net.Core.Level"/> collection whose elements should be added to the end of the <c>LevelCollection</c>.</param>
- <returns>The new <see cref="P:log4net.Core.LevelCollection.Count"/> of the <c>LevelCollection</c>.</returns>
- </member>
- <member name="M:log4net.Core.LevelCollection.TrimToSize">
- <summary>
- Sets the capacity to the actual number of elements.
- </summary>
- </member>
- <member name="M:log4net.Core.LevelCollection.ValidateIndex(System.Int32)">
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="i"/> is less than zero</para>
- <para>-or-</para>
- <para><paramref name="i"/> is equal to or greater than <see cref="P:log4net.Core.LevelCollection.Count"/>.</para>
- </exception>
- </member>
- <member name="M:log4net.Core.LevelCollection.ValidateIndex(System.Int32,System.Boolean)">
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="i"/> is less than zero</para>
- <para>-or-</para>
- <para><paramref name="i"/> is equal to or greater than <see cref="P:log4net.Core.LevelCollection.Count"/>.</para>
- </exception>
- </member>
- <member name="P:log4net.Core.LevelCollection.Count">
- <summary>
- Gets the number of elements actually contained in the <c>LevelCollection</c>.
- </summary>
- </member>
- <member name="P:log4net.Core.LevelCollection.IsSynchronized">
- <summary>
- Gets a value indicating whether access to the collection is synchronized (thread-safe).
- </summary>
- <value>true if access to the ICollection is synchronized (thread-safe); otherwise, false.</value>
- </member>
- <member name="P:log4net.Core.LevelCollection.SyncRoot">
- <summary>
- Gets an object that can be used to synchronize access to the collection.
- </summary>
- </member>
- <member name="P:log4net.Core.LevelCollection.Item(System.Int32)">
- <summary>
- Gets or sets the <see cref="T:log4net.Core.Level"/> at the specified index.
- </summary>
- <param name="index">The zero-based index of the element to get or set.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="index"/> is less than zero</para>
- <para>-or-</para>
- <para><paramref name="index"/> is equal to or greater than <see cref="P:log4net.Core.LevelCollection.Count"/>.</para>
- </exception>
- </member>
- <member name="P:log4net.Core.LevelCollection.IsFixedSize">
- <summary>
- Gets a value indicating whether the collection has a fixed size.
- </summary>
- <value>true if the collection has a fixed size; otherwise, false. The default is false</value>
- </member>
- <member name="P:log4net.Core.LevelCollection.IsReadOnly">
- <summary>
- Gets a value indicating whether the IList is read-only.
- </summary>
- <value>true if the collection is read-only; otherwise, false. The default is false</value>
- </member>
- <member name="P:log4net.Core.LevelCollection.Capacity">
- <summary>
- Gets or sets the number of elements the <c>LevelCollection</c> can contain.
- </summary>
- </member>
- <member name="T:log4net.Core.LevelCollection.ILevelCollectionEnumerator">
- <summary>
- Supports type-safe iteration over a <see cref="T:log4net.Core.LevelCollection"/>.
- </summary>
- </member>
- <member name="M:log4net.Core.LevelCollection.ILevelCollectionEnumerator.MoveNext">
- <summary>
- Advances the enumerator to the next element in the collection.
- </summary>
- <returns>
- <c>true</c> if the enumerator was successfully advanced to the next element;
- <c>false</c> if the enumerator has passed the end of the collection.
- </returns>
- <exception cref="T:System.InvalidOperationException">
- The collection was modified after the enumerator was created.
- </exception>
- </member>
- <member name="M:log4net.Core.LevelCollection.ILevelCollectionEnumerator.Reset">
- <summary>
- Sets the enumerator to its initial position, before the first element in the collection.
- </summary>
- </member>
- <member name="P:log4net.Core.LevelCollection.ILevelCollectionEnumerator.Current">
- <summary>
- Gets the current element in the collection.
- </summary>
- </member>
- <member name="T:log4net.Core.LevelCollection.Tag">
- <summary>
- Type visible only to our subclasses
- Used to access protected constructor
- </summary>
- </member>
- <member name="F:log4net.Core.LevelCollection.Tag.Default">
- <summary>
- A value
- </summary>
- </member>
- <member name="T:log4net.Core.LevelCollection.Enumerator">
- <summary>
- Supports simple iteration over a <see cref="T:log4net.Core.LevelCollection"/>.
- </summary>
- </member>
- <member name="M:log4net.Core.LevelCollection.Enumerator.#ctor(log4net.Core.LevelCollection)">
- <summary>
- Initializes a new instance of the <c>Enumerator</c> class.
- </summary>
- <param name="tc"></param>
- </member>
- <member name="M:log4net.Core.LevelCollection.Enumerator.MoveNext">
- <summary>
- Advances the enumerator to the next element in the collection.
- </summary>
- <returns>
- <c>true</c> if the enumerator was successfully advanced to the next element;
- <c>false</c> if the enumerator has passed the end of the collection.
- </returns>
- <exception cref="T:System.InvalidOperationException">
- The collection was modified after the enumerator was created.
- </exception>
- </member>
- <member name="M:log4net.Core.LevelCollection.Enumerator.Reset">
- <summary>
- Sets the enumerator to its initial position, before the first element in the collection.
- </summary>
- </member>
- <member name="P:log4net.Core.LevelCollection.Enumerator.Current">
- <summary>
- Gets the current element in the collection.
- </summary>
- </member>
- <member name="T:log4net.Core.LevelEvaluator">
- <summary>
- An evaluator that triggers at a threshold level
- </summary>
- <remarks>
- <para>
- This evaluator will trigger if the level of the event
- passed to <see cref="M:IsTriggeringEvent(LoggingEvent)"/>
- is equal to or greater than the <see cref="P:log4net.Core.LevelEvaluator.Threshold"/>
- level.
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- </member>
- <member name="F:log4net.Core.LevelEvaluator.m_threshold">
- <summary>
- The threshold for triggering
- </summary>
- </member>
- <member name="M:log4net.Core.LevelEvaluator.#ctor">
- <summary>
- Create a new evaluator using the <see cref="F:log4net.Core.Level.Off"/> threshold.
- </summary>
- <remarks>
- <para>
- Create a new evaluator using the <see cref="F:log4net.Core.Level.Off"/> threshold.
- </para>
- <para>
- This evaluator will trigger if the level of the event
- passed to <see cref="M:IsTriggeringEvent(LoggingEvent)"/>
- is equal to or greater than the <see cref="P:log4net.Core.LevelEvaluator.Threshold"/>
- level.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Core.LevelEvaluator.#ctor(log4net.Core.Level)">
- <summary>
- Create a new evaluator using the specified <see cref="T:log4net.Core.Level"/> threshold.
- </summary>
- <param name="threshold">the threshold to trigger at</param>
- <remarks>
- <para>
- Create a new evaluator using the specified <see cref="T:log4net.Core.Level"/> threshold.
- </para>
- <para>
- This evaluator will trigger if the level of the event
- passed to <see cref="M:IsTriggeringEvent(LoggingEvent)"/>
- is equal to or greater than the <see cref="P:log4net.Core.LevelEvaluator.Threshold"/>
- level.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Core.LevelEvaluator.IsTriggeringEvent(log4net.Core.LoggingEvent)">
- <summary>
- Is this <paramref name="loggingEvent"/> the triggering event?
- </summary>
- <param name="loggingEvent">The event to check</param>
- <returns>This method returns <c>true</c>, if the event level
- is equal or higher than the <see cref="P:log4net.Core.LevelEvaluator.Threshold"/>.
- Otherwise it returns <c>false</c></returns>
- <remarks>
- <para>
- This evaluator will trigger if the level of the event
- passed to <see cref="M:IsTriggeringEvent(LoggingEvent)"/>
- is equal to or greater than the <see cref="P:log4net.Core.LevelEvaluator.Threshold"/>
- level.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Core.LevelEvaluator.Threshold">
- <summary>
- the threshold to trigger at
- </summary>
- <value>
- The <see cref="T:log4net.Core.Level"/> that will cause this evaluator to trigger
- </value>
- <remarks>
- <para>
- This evaluator will trigger if the level of the event
- passed to <see cref="M:IsTriggeringEvent(LoggingEvent)"/>
- is equal to or greater than the <see cref="P:log4net.Core.LevelEvaluator.Threshold"/>
- level.
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Core.LevelMap">
- <summary>
- Mapping between string name and Level object
- </summary>
- <remarks>
- <para>
- Mapping between string name and <see cref="T:log4net.Core.Level"/> object.
- This mapping is held separately for each <see cref="T:log4net.Repository.ILoggerRepository"/>.
- The level name is case insensitive.
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- </member>
- <member name="F:log4net.Core.LevelMap.m_mapName2Level">
- <summary>
- Mapping from level name to Level object. The
- level name is case insensitive
- </summary>
- </member>
- <member name="M:log4net.Core.LevelMap.#ctor">
- <summary>
- Construct the level map
- </summary>
- <remarks>
- <para>
- Construct the level map.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Core.LevelMap.Clear">
- <summary>
- Clear the internal maps of all levels
- </summary>
- <remarks>
- <para>
- Clear the internal maps of all levels
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Core.LevelMap.Add(System.String,System.Int32)">
- <summary>
- Create a new Level and add it to the map
- </summary>
- <param name="name">the string to display for the Level</param>
- <param name="value">the level value to give to the Level</param>
- <remarks>
- <para>
- Create a new Level and add it to the map
- </para>
- </remarks>
- <seealso cref="M:Add(string,int,string)"/>
- </member>
- <member name="M:log4net.Core.LevelMap.Add(System.String,System.Int32,System.String)">
- <summary>
- Create a new Level and add it to the map
- </summary>
- <param name="name">the string to display for the Level</param>
- <param name="value">the level value to give to the Level</param>
- <param name="displayName">the display name to give to the Level</param>
- <remarks>
- <para>
- Create a new Level and add it to the map
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Core.LevelMap.Add(log4net.Core.Level)">
- <summary>
- Add a Level to the map
- </summary>
- <param name="level">the Level to add</param>
- <remarks>
- <para>
- Add a Level to the map
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Core.LevelMap.LookupWithDefault(log4net.Core.Level)">
- <summary>
- Lookup a named level from the map
- </summary>
- <param name="defaultLevel">the name of the level to lookup is taken from this level.
- If the level is not set on the map then this level is added</param>
- <returns>the level in the map with the name specified</returns>
- <remarks>
- <para>
- Lookup a named level from the map. The name of the level to lookup is taken
- from the <see cref="P:log4net.Core.Level.Name"/> property of the <paramref name="defaultLevel"/>
- argument.
- </para>
- <para>
- If no level with the specified name is found then the
- <paramref name="defaultLevel"/> argument is added to the level map
- and returned.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Core.LevelMap.Item(System.String)">
- <summary>
- Lookup a <see cref="T:log4net.Core.Level"/> by name
- </summary>
- <param name="name">The name of the Level to lookup</param>
- <returns>a Level from the map with the name specified</returns>
- <remarks>
- <para>
- Returns the <see cref="T:log4net.Core.Level"/> from the
- map with the name specified. If the no level is
- found then <c>null</c> is returned.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Core.LevelMap.AllLevels">
- <summary>
- Return all possible levels as a list of Level objects.
- </summary>
- <returns>all possible levels as a list of Level objects</returns>
- <remarks>
- <para>
- Return all possible levels as a list of Level objects.
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Core.LocationInfo">
- <summary>
- The internal representation of caller location information.
- </summary>
- <remarks>
- <para>
- This class uses the <c>System.Diagnostics.StackTrace</c> class to generate
- a call stack. The caller's information is then extracted from this stack.
- </para>
- <para>
- The <c>System.Diagnostics.StackTrace</c> class is not supported on the
- .NET Compact Framework 1.0 therefore caller location information is not
- available on that framework.
- </para>
- <para>
- The <c>System.Diagnostics.StackTrace</c> class has this to say about Release builds:
- </para>
- <para>
- "StackTrace information will be most informative with Debug build configurations.
- By default, Debug builds include debug symbols, while Release builds do not. The
- debug symbols contain most of the file, method name, line number, and column
- information used in constructing StackFrame and StackTrace objects. StackTrace
- might not report as many method calls as expected, due to code transformations
- that occur during optimization."
- </para>
- <para>
- This means that in a Release build the caller information may be incomplete or may
- not exist at all! Therefore caller location information cannot be relied upon in a Release build.
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- <author>Gert Driesen</author>
- </member>
- <member name="F:log4net.Core.LocationInfo.NA">
- <summary>
- When location information is not available the constant
- <c>NA</c> is returned. Current value of this string
- constant is <b>?</b>.
- </summary>
- </member>
- <member name="M:log4net.Core.LocationInfo.#ctor(System.Type)">
- <summary>
- Constructor
- </summary>
- <param name="callerStackBoundaryDeclaringType">The declaring type of the method that is
- the stack boundary into the logging system for this call.</param>
- <remarks>
- <para>
- Initializes a new instance of the <see cref="T:log4net.Core.LocationInfo"/>
- class based on the current thread.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Core.LocationInfo.#ctor(System.String,System.String,System.String,System.String)">
- <summary>
- Constructor
- </summary>
- <param name="className">The fully qualified class name.</param>
- <param name="methodName">The method name.</param>
- <param name="fileName">The file name.</param>
- <param name="lineNumber">The line number of the method within the file.</param>
- <remarks>
- <para>
- Initializes a new instance of the <see cref="T:log4net.Core.LocationInfo"/>
- class with the specified data.
- </para>
- </remarks>
- </member>
- <member name="F:log4net.Core.LocationInfo.declaringType">
- <summary>
- The fully qualified type of the LocationInfo class.
- </summary>
- <remarks>
- Used by the internal logger to record the Type of the
- log message.
- </remarks>
- </member>
- <member name="P:log4net.Core.LocationInfo.ClassName">
- <summary>
- Gets the fully qualified class name of the caller making the logging
- request.
- </summary>
- <value>
- The fully qualified class name of the caller making the logging
- request.
- </value>
- <remarks>
- <para>
- Gets the fully qualified class name of the caller making the logging
- request.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Core.LocationInfo.FileName">
- <summary>
- Gets the file name of the caller.
- </summary>
- <value>
- The file name of the caller.
- </value>
- <remarks>
- <para>
- Gets the file name of the caller.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Core.LocationInfo.LineNumber">
- <summary>
- Gets the line number of the caller.
- </summary>
- <value>
- The line number of the caller.
- </value>
- <remarks>
- <para>
- Gets the line number of the caller.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Core.LocationInfo.MethodName">
- <summary>
- Gets the method name of the caller.
- </summary>
- <value>
- The method name of the caller.
- </value>
- <remarks>
- <para>
- Gets the method name of the caller.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Core.LocationInfo.FullInfo">
- <summary>
- Gets all available caller information
- </summary>
- <value>
- All available caller information, in the format
- <c>fully.qualified.classname.of.caller.methodName(Filename:line)</c>
- </value>
- <remarks>
- <para>
- Gets all available caller information, in the format
- <c>fully.qualified.classname.of.caller.methodName(Filename:line)</c>
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Core.LocationInfo.StackFrames">
- <summary>
- Gets the stack frames from the stack trace of the caller making the log request
- </summary>
- </member>
- <member name="T:log4net.Core.LoggerManager">
- <summary>
- Static manager that controls the creation of repositories
- </summary>
- <remarks>
- <para>
- Static manager that controls the creation of repositories
- </para>
- <para>
- This class is used by the wrapper managers (e.g. <see cref="T:log4net.LogManager"/>)
- to provide access to the <see cref="T:log4net.Core.ILogger"/> objects.
- </para>
- <para>
- This manager also holds the <see cref="T:log4net.Core.IRepositorySelector"/> that is used to
- lookup and create repositories. The selector can be set either programmatically using
- the <see cref="P:log4net.Core.LoggerManager.RepositorySelector"/> property, or by setting the <c>log4net.RepositorySelector</c>
- AppSetting in the applications config file to the fully qualified type name of the
- selector to use.
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- <author>Gert Driesen</author>
- </member>
- <member name="M:log4net.Core.LoggerManager.#ctor">
- <summary>
- Private constructor to prevent instances. Only static methods should be used.
- </summary>
- <remarks>
- <para>
- Private constructor to prevent instances. Only static methods should be used.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Core.LoggerManager.#cctor">
- <summary>
- Hook the shutdown event
- </summary>
- <remarks>
- <para>
- On the full .NET runtime, the static constructor hooks up the
- <c>AppDomain.ProcessExit</c> and <c>AppDomain.DomainUnload</c>> events.
- These are used to shutdown the log4net system as the application exits.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Core.LoggerManager.RegisterAppDomainEvents">
- <summary>
- Register for ProcessExit and DomainUnload events on the AppDomain
- </summary>
- <remarks>
- <para>
- This needs to be in a separate method because the events make
- a LinkDemand for the ControlAppDomain SecurityPermission. Because
- this is a LinkDemand it is demanded at JIT time. Therefore we cannot
- catch the exception in the method itself, we have to catch it in the
- caller.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Core.LoggerManager.GetLoggerRepository(System.String)">
- <summary>
- Return the default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.
- </summary>
- <param name="repository">the repository to lookup in</param>
- <returns>Return the default <see cref="T:log4net.Repository.ILoggerRepository"/> instance</returns>
- <remarks>
- <para>
- Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified
- by the <paramref name="repository"/> argument.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Core.LoggerManager.GetLoggerRepository(System.Reflection.Assembly)">
- <summary>
- Returns the default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.
- </summary>
- <param name="repositoryAssembly">The assembly to use to lookup the repository.</param>
- <returns>The default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.</returns>
- </member>
- <member name="M:log4net.Core.LoggerManager.GetRepository(System.String)">
- <summary>
- Return the default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.
- </summary>
- <param name="repository">the repository to lookup in</param>
- <returns>Return the default <see cref="T:log4net.Repository.ILoggerRepository"/> instance</returns>
- <remarks>
- <para>
- Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified
- by the <paramref name="repository"/> argument.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Core.LoggerManager.GetRepository(System.Reflection.Assembly)">
- <summary>
- Returns the default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.
- </summary>
- <param name="repositoryAssembly">The assembly to use to lookup the repository.</param>
- <returns>The default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.</returns>
- <remarks>
- <para>
- Returns the default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Core.LoggerManager.Exists(System.String,System.String)">
- <summary>
- Returns the named logger if it exists.
- </summary>
- <param name="repository">The repository to lookup in.</param>
- <param name="name">The fully qualified logger name to look for.</param>
- <returns>
- The logger found, or <c>null</c> if the named logger does not exist in the
- specified repository.
- </returns>
- <remarks>
- <para>
- If the named logger exists (in the specified repository) then it
- returns a reference to the logger, otherwise it returns
- <c>null</c>.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Core.LoggerManager.Exists(System.Reflection.Assembly,System.String)">
- <summary>
- Returns the named logger if it exists.
- </summary>
- <param name="repositoryAssembly">The assembly to use to lookup the repository.</param>
- <param name="name">The fully qualified logger name to look for.</param>
- <returns>
- The logger found, or <c>null</c> if the named logger does not exist in the
- specified assembly's repository.
- </returns>
- <remarks>
- <para>
- If the named logger exists (in the specified assembly's repository) then it
- returns a reference to the logger, otherwise it returns
- <c>null</c>.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Core.LoggerManager.GetCurrentLoggers(System.String)">
- <summary>
- Returns all the currently defined loggers in the specified repository.
- </summary>
- <param name="repository">The repository to lookup in.</param>
- <returns>All the defined loggers.</returns>
- <remarks>
- <para>
- The root logger is <b>not</b> included in the returned array.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Core.LoggerManager.GetCurrentLoggers(System.Reflection.Assembly)">
- <summary>
- Returns all the currently defined loggers in the specified assembly's repository.
- </summary>
- <param name="repositoryAssembly">The assembly to use to lookup the repository.</param>
- <returns>All the defined loggers.</returns>
- <remarks>
- <para>
- The root logger is <b>not</b> included in the returned array.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Core.LoggerManager.GetLogger(System.String,System.String)">
- <summary>
- Retrieves or creates a named logger.
- </summary>
- <param name="repository">The repository to lookup in.</param>
- <param name="name">The name of the logger to retrieve.</param>
- <returns>The logger with the name specified.</returns>
- <remarks>
- <para>
- Retrieves a logger named as the <paramref name="name"/>
- parameter. If the named logger already exists, then the
- existing instance will be returned. Otherwise, a new instance is
- created.
- </para>
- <para>
- By default, loggers do not have a set level but inherit
- it from the hierarchy. This is one of the central features of
- log4net.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Core.LoggerManager.GetLogger(System.Reflection.Assembly,System.String)">
- <summary>
- Retrieves or creates a named logger.
- </summary>
- <param name="repositoryAssembly">The assembly to use to lookup the repository.</param>
- <param name="name">The name of the logger to retrieve.</param>
- <returns>The logger with the name specified.</returns>
- <remarks>
- <para>
- Retrieves a logger named as the <paramref name="name"/>
- parameter. If the named logger already exists, then the
- existing instance will be returned. Otherwise, a new instance is
- created.
- </para>
- <para>
- By default, loggers do not have a set level but inherit
- it from the hierarchy. This is one of the central features of
- log4net.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Core.LoggerManager.GetLogger(System.String,System.Type)">
- <summary>
- Shorthand for <see cref="M:LogManager.GetLogger(string)"/>.
- </summary>
- <param name="repository">The repository to lookup in.</param>
- <param name="type">The <paramref name="type"/> of which the fullname will be used as the name of the logger to retrieve.</param>
- <returns>The logger with the name specified.</returns>
- <remarks>
- <para>
- Gets the logger for the fully qualified name of the type specified.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Core.LoggerManager.GetLogger(System.Reflection.Assembly,System.Type)">
- <summary>
- Shorthand for <see cref="M:LogManager.GetLogger(string)"/>.
- </summary>
- <param name="repositoryAssembly">the assembly to use to lookup the repository</param>
- <param name="type">The <paramref name="type"/> of which the fullname will be used as the name of the logger to retrieve.</param>
- <returns>The logger with the name specified.</returns>
- <remarks>
- <para>
- Gets the logger for the fully qualified name of the type specified.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Core.LoggerManager.Shutdown">
- <summary>
- Shuts down the log4net system.
- </summary>
- <remarks>
- <para>
- Calling this method will <b>safely</b> close and remove all
- appenders in all the loggers including root contained in all the
- default repositories.
- </para>
- <para>
- Some appenders need to be closed before the application exists.
- Otherwise, pending logging events might be lost.
- </para>
- <para>
- The <c>shutdown</c> method is careful to close nested
- appenders before closing regular appenders. This is allows
- configurations where a regular appender is attached to a logger
- and again to a nested appender.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Core.LoggerManager.ShutdownRepository(System.String)">
- <summary>
- Shuts down the repository for the repository specified.
- </summary>
- <param name="repository">The repository to shutdown.</param>
- <remarks>
- <para>
- Calling this method will <b>safely</b> close and remove all
- appenders in all the loggers including root contained in the
- repository for the <paramref name="repository"/> specified.
- </para>
- <para>
- Some appenders need to be closed before the application exists.
- Otherwise, pending logging events might be lost.
- </para>
- <para>
- The <c>shutdown</c> method is careful to close nested
- appenders before closing regular appenders. This is allows
- configurations where a regular appender is attached to a logger
- and again to a nested appender.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Core.LoggerManager.ShutdownRepository(System.Reflection.Assembly)">
- <summary>
- Shuts down the repository for the repository specified.
- </summary>
- <param name="repositoryAssembly">The assembly to use to lookup the repository.</param>
- <remarks>
- <para>
- Calling this method will <b>safely</b> close and remove all
- appenders in all the loggers including root contained in the
- repository for the repository. The repository is looked up using
- the <paramref name="repositoryAssembly"/> specified.
- </para>
- <para>
- Some appenders need to be closed before the application exists.
- Otherwise, pending logging events might be lost.
- </para>
- <para>
- The <c>shutdown</c> method is careful to close nested
- appenders before closing regular appenders. This is allows
- configurations where a regular appender is attached to a logger
- and again to a nested appender.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Core.LoggerManager.ResetConfiguration(System.String)">
- <summary>
- Resets all values contained in this repository instance to their defaults.
- </summary>
- <param name="repository">The repository to reset.</param>
- <remarks>
- <para>
- Resets all values contained in the repository instance to their
- defaults. This removes all appenders from all loggers, sets
- the level of all non-root loggers to <c>null</c>,
- sets their additivity flag to <c>true</c> and sets the level
- of the root logger to <see cref="F:log4net.Core.Level.Debug"/>. Moreover,
- message disabling is set its default "off" value.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Core.LoggerManager.ResetConfiguration(System.Reflection.Assembly)">
- <summary>
- Resets all values contained in this repository instance to their defaults.
- </summary>
- <param name="repositoryAssembly">The assembly to use to lookup the repository to reset.</param>
- <remarks>
- <para>
- Resets all values contained in the repository instance to their
- defaults. This removes all appenders from all loggers, sets
- the level of all non-root loggers to <c>null</c>,
- sets their additivity flag to <c>true</c> and sets the level
- of the root logger to <see cref="F:log4net.Core.Level.Debug"/>. Moreover,
- message disabling is set its default "off" value.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Core.LoggerManager.CreateDomain(System.String)">
- <summary>
- Creates a repository with the specified name.
- </summary>
- <param name="repository">The name of the repository, this must be unique amongst repositories.</param>
- <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> created for the repository.</returns>
- <remarks>
- <para>
- <b>CreateDomain is obsolete. Use CreateRepository instead of CreateDomain.</b>
- </para>
- <para>
- Creates the default type of <see cref="T:log4net.Repository.ILoggerRepository"/> which is a
- <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/> object.
- </para>
- <para>
- The <paramref name="repository"/> name must be unique. Repositories cannot be redefined.
- An <see cref="T:System.Exception"/> will be thrown if the repository already exists.
- </para>
- </remarks>
- <exception cref="T:log4net.Core.LogException">The specified repository already exists.</exception>
- </member>
- <member name="M:log4net.Core.LoggerManager.CreateRepository(System.String)">
- <summary>
- Creates a repository with the specified name.
- </summary>
- <param name="repository">The name of the repository, this must be unique amongst repositories.</param>
- <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> created for the repository.</returns>
- <remarks>
- <para>
- Creates the default type of <see cref="T:log4net.Repository.ILoggerRepository"/> which is a
- <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/> object.
- </para>
- <para>
- The <paramref name="repository"/> name must be unique. Repositories cannot be redefined.
- An <see cref="T:System.Exception"/> will be thrown if the repository already exists.
- </para>
- </remarks>
- <exception cref="T:log4net.Core.LogException">The specified repository already exists.</exception>
- </member>
- <member name="M:log4net.Core.LoggerManager.CreateDomain(System.String,System.Type)">
- <summary>
- Creates a repository with the specified name and repository type.
- </summary>
- <param name="repository">The name of the repository, this must be unique to the repository.</param>
- <param name="repositoryType">A <see cref="T:System.Type"/> that implements <see cref="T:log4net.Repository.ILoggerRepository"/>
- and has a no arg constructor. An instance of this type will be created to act
- as the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified.</param>
- <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> created for the repository.</returns>
- <remarks>
- <para>
- <b>CreateDomain is obsolete. Use CreateRepository instead of CreateDomain.</b>
- </para>
- <para>
- The <paramref name="repository"/> name must be unique. Repositories cannot be redefined.
- An Exception will be thrown if the repository already exists.
- </para>
- </remarks>
- <exception cref="T:log4net.Core.LogException">The specified repository already exists.</exception>
- </member>
- <member name="M:log4net.Core.LoggerManager.CreateRepository(System.String,System.Type)">
- <summary>
- Creates a repository with the specified name and repository type.
- </summary>
- <param name="repository">The name of the repository, this must be unique to the repository.</param>
- <param name="repositoryType">A <see cref="T:System.Type"/> that implements <see cref="T:log4net.Repository.ILoggerRepository"/>
- and has a no arg constructor. An instance of this type will be created to act
- as the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified.</param>
- <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> created for the repository.</returns>
- <remarks>
- <para>
- The <paramref name="repository"/> name must be unique. Repositories cannot be redefined.
- An Exception will be thrown if the repository already exists.
- </para>
- </remarks>
- <exception cref="T:log4net.Core.LogException">The specified repository already exists.</exception>
- </member>
- <member name="M:log4net.Core.LoggerManager.CreateDomain(System.Reflection.Assembly,System.Type)">
- <summary>
- Creates a repository for the specified assembly and repository type.
- </summary>
- <param name="repositoryAssembly">The assembly to use to get the name of the repository.</param>
- <param name="repositoryType">A <see cref="T:System.Type"/> that implements <see cref="T:log4net.Repository.ILoggerRepository"/>
- and has a no arg constructor. An instance of this type will be created to act
- as the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified.</param>
- <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> created for the repository.</returns>
- <remarks>
- <para>
- <b>CreateDomain is obsolete. Use CreateRepository instead of CreateDomain.</b>
- </para>
- <para>
- The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be associated with the repository
- specified such that a call to <see cref="M:GetRepository(Assembly)"/> with the
- same assembly specified will return the same repository instance.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Core.LoggerManager.CreateRepository(System.Reflection.Assembly,System.Type)">
- <summary>
- Creates a repository for the specified assembly and repository type.
- </summary>
- <param name="repositoryAssembly">The assembly to use to get the name of the repository.</param>
- <param name="repositoryType">A <see cref="T:System.Type"/> that implements <see cref="T:log4net.Repository.ILoggerRepository"/>
- and has a no arg constructor. An instance of this type will be created to act
- as the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified.</param>
- <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> created for the repository.</returns>
- <remarks>
- <para>
- The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be associated with the repository
- specified such that a call to <see cref="M:GetRepository(Assembly)"/> with the
- same assembly specified will return the same repository instance.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Core.LoggerManager.GetAllRepositories">
- <summary>
- Gets an array of all currently defined repositories.
- </summary>
- <returns>An array of all the known <see cref="T:log4net.Repository.ILoggerRepository"/> objects.</returns>
- <remarks>
- <para>
- Gets an array of all currently defined repositories.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Core.LoggerManager.GetVersionInfo">
- <summary>
- Internal method to get pertinent version info.
- </summary>
- <returns>A string of version info.</returns>
- </member>
- <member name="M:log4net.Core.LoggerManager.OnDomainUnload(System.Object,System.EventArgs)">
- <summary>
- Called when the <see cref="E:System.AppDomain.DomainUnload"/> event fires
- </summary>
- <param name="sender">the <see cref="T:System.AppDomain"/> that is exiting</param>
- <param name="e">null</param>
- <remarks>
- <para>
- Called when the <see cref="E:System.AppDomain.DomainUnload"/> event fires.
- </para>
- <para>
- When the event is triggered the log4net system is <see cref="M:Shutdown()"/>.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Core.LoggerManager.OnProcessExit(System.Object,System.EventArgs)">
- <summary>
- Called when the <see cref="E:System.AppDomain.ProcessExit"/> event fires
- </summary>
- <param name="sender">the <see cref="T:System.AppDomain"/> that is exiting</param>
- <param name="e">null</param>
- <remarks>
- <para>
- Called when the <see cref="E:System.AppDomain.ProcessExit"/> event fires.
- </para>
- <para>
- When the event is triggered the log4net system is <see cref="M:Shutdown()"/>.
- </para>
- </remarks>
- </member>
- <member name="F:log4net.Core.LoggerManager.declaringType">
- <summary>
- The fully qualified type of the LoggerManager class.
- </summary>
- <remarks>
- Used by the internal logger to record the Type of the
- log message.
- </remarks>
- </member>
- <member name="F:log4net.Core.LoggerManager.s_repositorySelector">
- <summary>
- Initialize the default repository selector
- </summary>
- </member>
- <member name="P:log4net.Core.LoggerManager.RepositorySelector">
- <summary>
- Gets or sets the repository selector used by the <see cref="T:log4net.LogManager"/>.
- </summary>
- <value>
- The repository selector used by the <see cref="T:log4net.LogManager"/>.
- </value>
- <remarks>
- <para>
- The repository selector (<see cref="T:log4net.Core.IRepositorySelector"/>) is used by
- the <see cref="T:log4net.LogManager"/> to create and select repositories
- (<see cref="T:log4net.Repository.ILoggerRepository"/>).
- </para>
- <para>
- The caller to <see cref="T:log4net.LogManager"/> supplies either a string name
- or an assembly (if not supplied the assembly is inferred using
- <see cref="M:Assembly.GetCallingAssembly()"/>).
- </para>
- <para>
- This context is used by the selector to lookup a specific repository.
- </para>
- <para>
- For the full .NET Framework, the default repository is <c>DefaultRepositorySelector</c>;
- for the .NET Compact Framework <c>CompactRepositorySelector</c> is the default
- repository.
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Core.LoggerWrapperImpl">
- <summary>
- Implementation of the <see cref="T:log4net.Core.ILoggerWrapper"/> interface.
- </summary>
- <remarks>
- <para>
- This class should be used as the base for all wrapper implementations.
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- <author>Gert Driesen</author>
- </member>
- <member name="M:log4net.Core.LoggerWrapperImpl.#ctor(log4net.Core.ILogger)">
- <summary>
- Constructs a new wrapper for the specified logger.
- </summary>
- <param name="logger">The logger to wrap.</param>
- <remarks>
- <para>
- Constructs a new wrapper for the specified logger.
- </para>
- </remarks>
- </member>
- <member name="F:log4net.Core.LoggerWrapperImpl.m_logger">
- <summary>
- The logger that this object is wrapping
- </summary>
- </member>
- <member name="P:log4net.Core.LoggerWrapperImpl.Logger">
- <summary>
- Gets the implementation behind this wrapper object.
- </summary>
- <value>
- The <see cref="T:log4net.Core.ILogger"/> object that this object is implementing.
- </value>
- <remarks>
- <para>
- The <c>Logger</c> object may not be the same object as this object
- because of logger decorators.
- </para>
- <para>
- This gets the actual underlying objects that is used to process
- the log events.
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Core.LoggingEventData">
- <summary>
- Portable data structure used by <see cref="T:log4net.Core.LoggingEvent"/>
- </summary>
- <remarks>
- <para>
- Portable data structure used by <see cref="T:log4net.Core.LoggingEvent"/>
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- </member>
- <member name="F:log4net.Core.LoggingEventData.LoggerName">
- <summary>
- The logger name.
- </summary>
- <remarks>
- <para>
- The logger name.
- </para>
- </remarks>
- </member>
- <member name="F:log4net.Core.LoggingEventData.Level">
- <summary>
- Level of logging event.
- </summary>
- <remarks>
- <para>
- Level of logging event. Level cannot be Serializable
- because it is a flyweight. Due to its special serialization it
- cannot be declared final either.
- </para>
- </remarks>
- </member>
- <member name="F:log4net.Core.LoggingEventData.Message">
- <summary>
- The application supplied message.
- </summary>
- <remarks>
- <para>
- The application supplied message of logging event.
- </para>
- </remarks>
- </member>
- <member name="F:log4net.Core.LoggingEventData.ThreadName">
- <summary>
- The name of thread
- </summary>
- <remarks>
- <para>
- The name of thread in which this logging event was generated
- </para>
- </remarks>
- </member>
- <member name="F:log4net.Core.LoggingEventData.TimeStamp">
- <summary>
- The time the event was logged
- </summary>
- <remarks>
- <para>
- The TimeStamp is stored in the local time zone for this computer.
- </para>
- </remarks>
- </member>
- <member name="F:log4net.Core.LoggingEventData.LocationInfo">
- <summary>
- Location information for the caller.
- </summary>
- <remarks>
- <para>
- Location information for the caller.
- </para>
- </remarks>
- </member>
- <member name="F:log4net.Core.LoggingEventData.UserName">
- <summary>
- String representation of the user
- </summary>
- <remarks>
- <para>
- String representation of the user's windows name,
- like DOMAIN\username
- </para>
- </remarks>
- </member>
- <member name="F:log4net.Core.LoggingEventData.Identity">
- <summary>
- String representation of the identity.
- </summary>
- <remarks>
- <para>
- String representation of the current thread's principal identity.
- </para>
- </remarks>
- </member>
- <member name="F:log4net.Core.LoggingEventData.ExceptionString">
- <summary>
- The string representation of the exception
- </summary>
- <remarks>
- <para>
- The string representation of the exception
- </para>
- </remarks>
- </member>
- <member name="F:log4net.Core.LoggingEventData.Domain">
- <summary>
- String representation of the AppDomain.
- </summary>
- <remarks>
- <para>
- String representation of the AppDomain.
- </para>
- </remarks>
- </member>
- <member name="F:log4net.Core.LoggingEventData.Properties">
- <summary>
- Additional event specific properties
- </summary>
- <remarks>
- <para>
- A logger or an appender may attach additional
- properties to specific events. These properties
- have a string key and an object value.
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Core.FixFlags">
- <summary>
- Flags passed to the <see cref="P:log4net.Core.LoggingEvent.Fix"/> property
- </summary>
- <remarks>
- <para>
- Flags passed to the <see cref="P:log4net.Core.LoggingEvent.Fix"/> property
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- </member>
- <member name="F:log4net.Core.FixFlags.Mdc">
- <summary>
- Fix the MDC
- </summary>
- </member>
- <member name="F:log4net.Core.FixFlags.Ndc">
- <summary>
- Fix the NDC
- </summary>
- </member>
- <member name="F:log4net.Core.FixFlags.Message">
- <summary>
- Fix the rendered message
- </summary>
- </member>
- <member name="F:log4net.Core.FixFlags.ThreadName">
- <summary>
- Fix the thread name
- </summary>
- </member>
- <member name="F:log4net.Core.FixFlags.LocationInfo">
- <summary>
- Fix the callers location information
- </summary>
- <remarks>
- CAUTION: Very slow to generate
- </remarks>
- </member>
- <member name="F:log4net.Core.FixFlags.UserName">
- <summary>
- Fix the callers windows user name
- </summary>
- <remarks>
- CAUTION: Slow to generate
- </remarks>
- </member>
- <member name="F:log4net.Core.FixFlags.Domain">
- <summary>
- Fix the domain friendly name
- </summary>
- </member>
- <member name="F:log4net.Core.FixFlags.Identity">
- <summary>
- Fix the callers principal name
- </summary>
- <remarks>
- CAUTION: May be slow to generate
- </remarks>
- </member>
- <member name="F:log4net.Core.FixFlags.Exception">
- <summary>
- Fix the exception text
- </summary>
- </member>
- <member name="F:log4net.Core.FixFlags.Properties">
- <summary>
- Fix the event properties. Active properties must implement <see cref="T:log4net.Core.IFixingRequired"/> in order to be eligible for fixing.
- </summary>
- </member>
- <member name="F:log4net.Core.FixFlags.None">
- <summary>
- No fields fixed
- </summary>
- </member>
- <member name="F:log4net.Core.FixFlags.All">
- <summary>
- All fields fixed
- </summary>
- </member>
- <member name="F:log4net.Core.FixFlags.Partial">
- <summary>
- Partial fields fixed
- </summary>
- <remarks>
- <para>
- This set of partial fields gives good performance. The following fields are fixed:
- </para>
- <list type="bullet">
- <item><description><see cref="F:log4net.Core.FixFlags.Message"/></description></item>
- <item><description><see cref="F:log4net.Core.FixFlags.ThreadName"/></description></item>
- <item><description><see cref="F:log4net.Core.FixFlags.Exception"/></description></item>
- <item><description><see cref="F:log4net.Core.FixFlags.Domain"/></description></item>
- <item><description><see cref="F:log4net.Core.FixFlags.Properties"/></description></item>
- </list>
- </remarks>
- </member>
- <member name="T:log4net.Core.LoggingEvent">
- <summary>
- The internal representation of logging events.
- </summary>
- <remarks>
- <para>
- When an affirmative decision is made to log then a
- <see cref="T:log4net.Core.LoggingEvent"/> instance is created. This instance
- is passed around to the different log4net components.
- </para>
- <para>
- This class is of concern to those wishing to extend log4net.
- </para>
- <para>
- Some of the values in instances of <see cref="T:log4net.Core.LoggingEvent"/>
- are considered volatile, that is the values are correct at the
- time the event is delivered to appenders, but will not be consistent
- at any time afterwards. If an event is to be stored and then processed
- at a later time these volatile values must be fixed by calling
- <see cref="M:FixVolatileData()"/>. There is a performance penalty
- for incurred by calling <see cref="M:FixVolatileData()"/> but it
- is essential to maintaining data consistency.
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- <author>Gert Driesen</author>
- <author>Douglas de la Torre</author>
- <author>Daniel Cazzulino</author>
- </member>
- <member name="F:log4net.Core.LoggingEvent.HostNameProperty">
- <summary>
- The key into the Properties map for the host name value.
- </summary>
- </member>
- <member name="F:log4net.Core.LoggingEvent.IdentityProperty">
- <summary>
- The key into the Properties map for the thread identity value.
- </summary>
- </member>
- <member name="F:log4net.Core.LoggingEvent.UserNameProperty">
- <summary>
- The key into the Properties map for the user name value.
- </summary>
- </member>
- <member name="M:log4net.Core.LoggingEvent.#ctor(System.Type,log4net.Repository.ILoggerRepository,System.String,log4net.Core.Level,System.Object,System.Exception)">
- <summary>
- Initializes a new instance of the <see cref="T:log4net.Core.LoggingEvent"/> class
- from the supplied parameters.
- </summary>
- <param name="callerStackBoundaryDeclaringType">The declaring type of the method that is
- the stack boundary into the logging system for this call.</param>
- <param name="repository">The repository this event is logged in.</param>
- <param name="loggerName">The name of the logger of this event.</param>
- <param name="level">The level of this event.</param>
- <param name="message">The message of this event.</param>
- <param name="exception">The exception for this event.</param>
- <remarks>
- <para>
- Except <see cref="P:log4net.Core.LoggingEvent.TimeStamp"/>, <see cref="P:log4net.Core.LoggingEvent.Level"/> and <see cref="P:log4net.Core.LoggingEvent.LoggerName"/>,
- all fields of <c>LoggingEvent</c> are filled when actually needed. Call
- <see cref="M:FixVolatileData()"/> to cache all data locally
- to prevent inconsistencies.
- </para>
- <para>This method is called by the log4net framework
- to create a logging event.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Core.LoggingEvent.#ctor(System.Type,log4net.Repository.ILoggerRepository,log4net.Core.LoggingEventData,log4net.Core.FixFlags)">
- <summary>
- Initializes a new instance of the <see cref="T:log4net.Core.LoggingEvent"/> class
- using specific data.
- </summary>
- <param name="callerStackBoundaryDeclaringType">The declaring type of the method that is
- the stack boundary into the logging system for this call.</param>
- <param name="repository">The repository this event is logged in.</param>
- <param name="data">Data used to initialize the logging event.</param>
- <param name="fixedData">The fields in the <paranref name="data"/> struct that have already been fixed.</param>
- <remarks>
- <para>
- This constructor is provided to allow a <see cref="T:log4net.Core.LoggingEvent"/>
- to be created independently of the log4net framework. This can
- be useful if you require a custom serialization scheme.
- </para>
- <para>
- Use the <see cref="M:GetLoggingEventData(FixFlags)"/> method to obtain an
- instance of the <see cref="T:log4net.Core.LoggingEventData"/> class.
- </para>
- <para>
- The <paramref name="fixedData"/> parameter should be used to specify which fields in the
- <paramref name="data"/> struct have been preset. Fields not specified in the <paramref name="fixedData"/>
- will be captured from the environment if requested or fixed.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Core.LoggingEvent.#ctor(System.Type,log4net.Repository.ILoggerRepository,log4net.Core.LoggingEventData)">
- <summary>
- Initializes a new instance of the <see cref="T:log4net.Core.LoggingEvent"/> class
- using specific data.
- </summary>
- <param name="callerStackBoundaryDeclaringType">The declaring type of the method that is
- the stack boundary into the logging system for this call.</param>
- <param name="repository">The repository this event is logged in.</param>
- <param name="data">Data used to initialize the logging event.</param>
- <remarks>
- <para>
- This constructor is provided to allow a <see cref="T:log4net.Core.LoggingEvent"/>
- to be created independently of the log4net framework. This can
- be useful if you require a custom serialization scheme.
- </para>
- <para>
- Use the <see cref="M:GetLoggingEventData(FixFlags)"/> method to obtain an
- instance of the <see cref="T:log4net.Core.LoggingEventData"/> class.
- </para>
- <para>
- This constructor sets this objects <see cref="P:log4net.Core.LoggingEvent.Fix"/> flags to <see cref="F:log4net.Core.FixFlags.All"/>,
- this assumes that all the data relating to this event is passed in via the <paramref name="data"/>
- parameter and no other data should be captured from the environment.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Core.LoggingEvent.#ctor(log4net.Core.LoggingEventData)">
- <summary>
- Initializes a new instance of the <see cref="T:log4net.Core.LoggingEvent"/> class
- using specific data.
- </summary>
- <param name="data">Data used to initialize the logging event.</param>
- <remarks>
- <para>
- This constructor is provided to allow a <see cref="T:log4net.Core.LoggingEvent"/>
- to be created independently of the log4net framework. This can
- be useful if you require a custom serialization scheme.
- </para>
- <para>
- Use the <see cref="M:GetLoggingEventData(FixFlags)"/> method to obtain an
- instance of the <see cref="T:log4net.Core.LoggingEventData"/> class.
- </para>
- <para>
- This constructor sets this objects <see cref="P:log4net.Core.LoggingEvent.Fix"/> flags to <see cref="F:log4net.Core.FixFlags.All"/>,
- this assumes that all the data relating to this event is passed in via the <paramref name="data"/>
- parameter and no other data should be captured from the environment.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Core.LoggingEvent.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Serialization constructor
- </summary>
- <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data.</param>
- <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
- <remarks>
- <para>
- Initializes a new instance of the <see cref="T:log4net.Core.LoggingEvent"/> class
- with serialized data.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Core.LoggingEvent.EnsureRepository(log4net.Repository.ILoggerRepository)">
- <summary>
- Ensure that the repository is set.
- </summary>
- <param name="repository">the value for the repository</param>
- </member>
- <member name="M:log4net.Core.LoggingEvent.WriteRenderedMessage(System.IO.TextWriter)">
- <summary>
- Write the rendered message to a TextWriter
- </summary>
- <param name="writer">the writer to write the message to</param>
- <remarks>
- <para>
- Unlike the <see cref="P:log4net.Core.LoggingEvent.RenderedMessage"/> property this method
- does store the message data in the internal cache. Therefore
- if called only once this method should be faster than the
- <see cref="P:log4net.Core.LoggingEvent.RenderedMessage"/> property, however if the message is
- to be accessed multiple times then the property will be more efficient.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Core.LoggingEvent.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Serializes this object into the <see cref="T:System.Runtime.Serialization.SerializationInfo"/> provided.
- </summary>
- <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> to populate with data.</param>
- <param name="context">The destination for this serialization.</param>
- <remarks>
- <para>
- The data in this event must be fixed before it can be serialized.
- </para>
- <para>
- The <see cref="M:FixVolatileData()"/> method must be called during the
- <see cref="M:log4net.Appender.IAppender.DoAppend(log4net.Core.LoggingEvent)"/> method call if this event
- is to be used outside that method.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Core.LoggingEvent.GetLoggingEventData">
- <summary>
- Gets the portable data for this <see cref="T:log4net.Core.LoggingEvent"/>.
- </summary>
- <returns>The <see cref="T:log4net.Core.LoggingEventData"/> for this event.</returns>
- <remarks>
- <para>
- A new <see cref="T:log4net.Core.LoggingEvent"/> can be constructed using a
- <see cref="T:log4net.Core.LoggingEventData"/> instance.
- </para>
- <para>
- Does a <see cref="F:log4net.Core.FixFlags.Partial"/> fix of the data
- in the logging event before returning the event data.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Core.LoggingEvent.GetLoggingEventData(log4net.Core.FixFlags)">
- <summary>
- Gets the portable data for this <see cref="T:log4net.Core.LoggingEvent"/>.
- </summary>
- <param name="fixFlags">The set of data to ensure is fixed in the LoggingEventData</param>
- <returns>The <see cref="T:log4net.Core.LoggingEventData"/> for this event.</returns>
- <remarks>
- <para>
- A new <see cref="T:log4net.Core.LoggingEvent"/> can be constructed using a
- <see cref="T:log4net.Core.LoggingEventData"/> instance.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Core.LoggingEvent.GetExceptionStrRep">
- <summary>
- Returns this event's exception's rendered using the
- <see cref="P:log4net.Repository.ILoggerRepository.RendererMap"/>.
- </summary>
- <returns>
- This event's exception's rendered using the <see cref="P:log4net.Repository.ILoggerRepository.RendererMap"/>.
- </returns>
- <remarks>
- <para>
- <b>Obsolete. Use <see cref="M:log4net.Core.LoggingEvent.GetExceptionString"/> instead.</b>
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Core.LoggingEvent.GetExceptionString">
- <summary>
- Returns this event's exception's rendered using the
- <see cref="P:log4net.Repository.ILoggerRepository.RendererMap"/>.
- </summary>
- <returns>
- This event's exception's rendered using the <see cref="P:log4net.Repository.ILoggerRepository.RendererMap"/>.
- </returns>
- <remarks>
- <para>
- Returns this event's exception's rendered using the
- <see cref="P:log4net.Repository.ILoggerRepository.RendererMap"/>.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Core.LoggingEvent.FixVolatileData">
- <summary>
- Fix instance fields that hold volatile data.
- </summary>
- <remarks>
- <para>
- Some of the values in instances of <see cref="T:log4net.Core.LoggingEvent"/>
- are considered volatile, that is the values are correct at the
- time the event is delivered to appenders, but will not be consistent
- at any time afterwards. If an event is to be stored and then processed
- at a later time these volatile values must be fixed by calling
- <see cref="M:FixVolatileData()"/>. There is a performance penalty
- incurred by calling <see cref="M:FixVolatileData()"/> but it
- is essential to maintaining data consistency.
- </para>
- <para>
- Calling <see cref="M:FixVolatileData()"/> is equivalent to
- calling <see cref="M:FixVolatileData(bool)"/> passing the parameter
- <c>false</c>.
- </para>
- <para>
- See <see cref="M:FixVolatileData(bool)"/> for more
- information.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Core.LoggingEvent.FixVolatileData(System.Boolean)">
- <summary>
- Fixes instance fields that hold volatile data.
- </summary>
- <param name="fastButLoose">Set to <c>true</c> to not fix data that takes a long time to fix.</param>
- <remarks>
- <para>
- Some of the values in instances of <see cref="T:log4net.Core.LoggingEvent"/>
- are considered volatile, that is the values are correct at the
- time the event is delivered to appenders, but will not be consistent
- at any time afterwards. If an event is to be stored and then processed
- at a later time these volatile values must be fixed by calling
- <see cref="M:FixVolatileData()"/>. There is a performance penalty
- for incurred by calling <see cref="M:FixVolatileData()"/> but it
- is essential to maintaining data consistency.
- </para>
- <para>
- The <paramref name="fastButLoose"/> param controls the data that
- is fixed. Some of the data that can be fixed takes a long time to
- generate, therefore if you do not require those settings to be fixed
- they can be ignored by setting the <paramref name="fastButLoose"/> param
- to <c>true</c>. This setting will ignore the <see cref="P:log4net.Core.LoggingEvent.LocationInformation"/>
- and <see cref="P:log4net.Core.LoggingEvent.UserName"/> settings.
- </para>
- <para>
- Set <paramref name="fastButLoose"/> to <c>false</c> to ensure that all
- settings are fixed.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Core.LoggingEvent.FixVolatileData(log4net.Core.FixFlags)">
- <summary>
- Fix the fields specified by the <see cref="T:log4net.Core.FixFlags"/> parameter
- </summary>
- <param name="flags">the fields to fix</param>
- <remarks>
- <para>
- Only fields specified in the <paramref name="flags"/> will be fixed.
- Fields will not be fixed if they have previously been fixed.
- It is not possible to 'unfix' a field.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Core.LoggingEvent.LookupProperty(System.String)">
- <summary>
- Lookup a composite property in this event
- </summary>
- <param name="key">the key for the property to lookup</param>
- <returns>the value for the property</returns>
- <remarks>
- <para>
- This event has composite properties that combine together properties from
- several different contexts in the following order:
- <list type="definition">
- <item>
- <term>this events properties</term>
- <description>
- This event has <see cref="P:log4net.Core.LoggingEvent.Properties"/> that can be set. These
- properties are specific to this event only.
- </description>
- </item>
- <item>
- <term>the thread properties</term>
- <description>
- The <see cref="P:log4net.ThreadContext.Properties"/> that are set on the current
- thread. These properties are shared by all events logged on this thread.
- </description>
- </item>
- <item>
- <term>the global properties</term>
- <description>
- The <see cref="P:log4net.GlobalContext.Properties"/> that are set globally. These
- properties are shared by all the threads in the AppDomain.
- </description>
- </item>
- </list>
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Core.LoggingEvent.GetProperties">
- <summary>
- Get all the composite properties in this event
- </summary>
- <returns>the <see cref="T:log4net.Util.PropertiesDictionary"/> containing all the properties</returns>
- <remarks>
- <para>
- See <see cref="M:log4net.Core.LoggingEvent.LookupProperty(System.String)"/> for details of the composite properties
- stored by the event.
- </para>
- <para>
- This method returns a single <see cref="T:log4net.Util.PropertiesDictionary"/> containing all the
- properties defined for this event.
- </para>
- </remarks>
- </member>
- <member name="F:log4net.Core.LoggingEvent.m_data">
- <summary>
- The internal logging event data.
- </summary>
- </member>
- <member name="F:log4net.Core.LoggingEvent.m_compositeProperties">
- <summary>
- The internal logging event data.
- </summary>
- </member>
- <member name="F:log4net.Core.LoggingEvent.m_eventProperties">
- <summary>
- The internal logging event data.
- </summary>
- </member>
- <member name="F:log4net.Core.LoggingEvent.m_callerStackBoundaryDeclaringType">
- <summary>
- The fully qualified Type of the calling
- logger class in the stack frame (i.e. the declaring type of the method).
- </summary>
- </member>
- <member name="F:log4net.Core.LoggingEvent.m_message">
- <summary>
- The application supplied message of logging event.
- </summary>
- </member>
- <member name="F:log4net.Core.LoggingEvent.m_thrownException">
- <summary>
- The exception that was thrown.
- </summary>
- <remarks>
- This is not serialized. The string representation
- is serialized instead.
- </remarks>
- </member>
- <member name="F:log4net.Core.LoggingEvent.m_repository">
- <summary>
- The repository that generated the logging event
- </summary>
- <remarks>
- This is not serialized.
- </remarks>
- </member>
- <member name="F:log4net.Core.LoggingEvent.m_fixFlags">
- <summary>
- The fix state for this event
- </summary>
- <remarks>
- These flags indicate which fields have been fixed.
- Not serialized.
- </remarks>
- </member>
- <member name="F:log4net.Core.LoggingEvent.m_cacheUpdatable">
- <summary>
- Indicated that the internal cache is updateable (ie not fixed)
- </summary>
- <remarks>
- This is a seperate flag to m_fixFlags as it allows incrementel fixing and simpler
- changes in the caching strategy.
- </remarks>
- </member>
- <member name="P:log4net.Core.LoggingEvent.StartTime">
- <summary>
- Gets the time when the current process started.
- </summary>
- <value>
- This is the time when this process started.
- </value>
- <remarks>
- <para>
- The TimeStamp is stored in the local time zone for this computer.
- </para>
- <para>
- Tries to get the start time for the current process.
- Failing that it returns the time of the first call to
- this property.
- </para>
- <para>
- Note that AppDomains may be loaded and unloaded within the
- same process without the process terminating and therefore
- without the process start time being reset.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Core.LoggingEvent.Level">
- <summary>
- Gets the <see cref="P:log4net.Core.LoggingEvent.Level"/> of the logging event.
- </summary>
- <value>
- The <see cref="P:log4net.Core.LoggingEvent.Level"/> of the logging event.
- </value>
- <remarks>
- <para>
- Gets the <see cref="P:log4net.Core.LoggingEvent.Level"/> of the logging event.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Core.LoggingEvent.TimeStamp">
- <summary>
- Gets the time of the logging event.
- </summary>
- <value>
- The time of the logging event.
- </value>
- <remarks>
- <para>
- The TimeStamp is stored in the local time zone for this computer.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Core.LoggingEvent.LoggerName">
- <summary>
- Gets the name of the logger that logged the event.
- </summary>
- <value>
- The name of the logger that logged the event.
- </value>
- <remarks>
- <para>
- Gets the name of the logger that logged the event.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Core.LoggingEvent.LocationInformation">
- <summary>
- Gets the location information for this logging event.
- </summary>
- <value>
- The location information for this logging event.
- </value>
- <remarks>
- <para>
- The collected information is cached for future use.
- </para>
- <para>
- See the <see cref="T:log4net.Core.LocationInfo"/> class for more information on
- supported frameworks and the different behavior in Debug and
- Release builds.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Core.LoggingEvent.MessageObject">
- <summary>
- Gets the message object used to initialize this event.
- </summary>
- <value>
- The message object used to initialize this event.
- </value>
- <remarks>
- <para>
- Gets the message object used to initialize this event.
- Note that this event may not have a valid message object.
- If the event is serialized the message object will not
- be transferred. To get the text of the message the
- <see cref="P:log4net.Core.LoggingEvent.RenderedMessage"/> property must be used
- not this property.
- </para>
- <para>
- If there is no defined message object for this event then
- null will be returned.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Core.LoggingEvent.ExceptionObject">
- <summary>
- Gets the exception object used to initialize this event.
- </summary>
- <value>
- The exception object used to initialize this event.
- </value>
- <remarks>
- <para>
- Gets the exception object used to initialize this event.
- Note that this event may not have a valid exception object.
- If the event is serialized the exception object will not
- be transferred. To get the text of the exception the
- <see cref="M:log4net.Core.LoggingEvent.GetExceptionString"/> method must be used
- not this property.
- </para>
- <para>
- If there is no defined exception object for this event then
- null will be returned.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Core.LoggingEvent.Repository">
- <summary>
- The <see cref="T:log4net.Repository.ILoggerRepository"/> that this event was created in.
- </summary>
- <remarks>
- <para>
- The <see cref="T:log4net.Repository.ILoggerRepository"/> that this event was created in.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Core.LoggingEvent.RenderedMessage">
- <summary>
- Gets the message, rendered through the <see cref="P:log4net.Repository.ILoggerRepository.RendererMap"/>.
- </summary>
- <value>
- The message rendered through the <see cref="P:log4net.Repository.ILoggerRepository.RendererMap"/>.
- </value>
- <remarks>
- <para>
- The collected information is cached for future use.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Core.LoggingEvent.ThreadName">
- <summary>
- Gets the name of the current thread.
- </summary>
- <value>
- The name of the current thread, or the thread ID when
- the name is not available.
- </value>
- <remarks>
- <para>
- The collected information is cached for future use.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Core.LoggingEvent.UserName">
- <summary>
- Gets the name of the current user.
- </summary>
- <value>
- The name of the current user, or <c>NOT AVAILABLE</c> when the
- underlying runtime has no support for retrieving the name of the
- current user.
- </value>
- <remarks>
- <para>
- Calls <c>WindowsIdentity.GetCurrent().Name</c> to get the name of
- the current windows user.
- </para>
- <para>
- To improve performance, we could cache the string representation of
- the name, and reuse that as long as the identity stayed constant.
- Once the identity changed, we would need to re-assign and re-render
- the string.
- </para>
- <para>
- However, the <c>WindowsIdentity.GetCurrent()</c> call seems to
- return different objects every time, so the current implementation
- doesn't do this type of caching.
- </para>
- <para>
- Timing for these operations:
- </para>
- <list type="table">
- <listheader>
- <term>Method</term>
- <description>Results</description>
- </listheader>
- <item>
- <term><c>WindowsIdentity.GetCurrent()</c></term>
- <description>10000 loops, 00:00:00.2031250 seconds</description>
- </item>
- <item>
- <term><c>WindowsIdentity.GetCurrent().Name</c></term>
- <description>10000 loops, 00:00:08.0468750 seconds</description>
- </item>
- </list>
- <para>
- This means we could speed things up almost 40 times by caching the
- value of the <c>WindowsIdentity.GetCurrent().Name</c> property, since
- this takes (8.04-0.20) = 7.84375 seconds.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Core.LoggingEvent.Identity">
- <summary>
- Gets the identity of the current thread principal.
- </summary>
- <value>
- The string name of the identity of the current thread principal.
- </value>
- <remarks>
- <para>
- Calls <c>System.Threading.Thread.CurrentPrincipal.Identity.Name</c> to get
- the name of the current thread principal.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Core.LoggingEvent.Domain">
- <summary>
- Gets the AppDomain friendly name.
- </summary>
- <value>
- The AppDomain friendly name.
- </value>
- <remarks>
- <para>
- Gets the AppDomain friendly name.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Core.LoggingEvent.Properties">
- <summary>
- Additional event specific properties.
- </summary>
- <value>
- Additional event specific properties.
- </value>
- <remarks>
- <para>
- A logger or an appender may attach additional
- properties to specific events. These properties
- have a string key and an object value.
- </para>
- <para>
- This property is for events that have been added directly to
- this event. The aggregate properties (which include these
- event properties) can be retrieved using <see cref="M:log4net.Core.LoggingEvent.LookupProperty(System.String)"/>
- and <see cref="M:log4net.Core.LoggingEvent.GetProperties"/>.
- </para>
- <para>
- Once the properties have been fixed <see cref="P:log4net.Core.LoggingEvent.Fix"/> this property
- returns the combined cached properties. This ensures that updates to
- this property are always reflected in the underlying storage. When
- returning the combined properties there may be more keys in the
- Dictionary than expected.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Core.LoggingEvent.Fix">
- <summary>
- The fixed fields in this event
- </summary>
- <value>
- The set of fields that are fixed in this event
- </value>
- <remarks>
- <para>
- Fields will not be fixed if they have previously been fixed.
- It is not possible to 'unfix' a field.
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Core.LogImpl">
- <summary>
- Implementation of <see cref="T:log4net.ILog"/> wrapper interface.
- </summary>
- <remarks>
- <para>
- This implementation of the <see cref="T:log4net.ILog"/> interface
- forwards to the <see cref="T:log4net.Core.ILogger"/> held by the base class.
- </para>
- <para>
- This logger has methods to allow the caller to log at the following
- levels:
- </para>
- <list type="definition">
- <item>
- <term>DEBUG</term>
- <description>
- The <see cref="M:Debug(object)"/> and <see cref="M:DebugFormat(string, object[])"/> methods log messages
- at the <c>DEBUG</c> level. That is the level with that name defined in the
- repositories <see cref="P:log4net.Repository.ILoggerRepository.LevelMap"/>. The default value
- for this level is <see cref="F:log4net.Core.Level.Debug"/>. The <see cref="P:log4net.Core.LogImpl.IsDebugEnabled"/>
- property tests if this level is enabled for logging.
- </description>
- </item>
- <item>
- <term>INFO</term>
- <description>
- The <see cref="M:Info(object)"/> and <see cref="M:InfoFormat(string, object[])"/> methods log messages
- at the <c>INFO</c> level. That is the level with that name defined in the
- repositories <see cref="P:log4net.Repository.ILoggerRepository.LevelMap"/>. The default value
- for this level is <see cref="F:log4net.Core.Level.Info"/>. The <see cref="P:log4net.Core.LogImpl.IsInfoEnabled"/>
- property tests if this level is enabled for logging.
- </description>
- </item>
- <item>
- <term>WARN</term>
- <description>
- The <see cref="M:Warn(object)"/> and <see cref="M:WarnFormat(string, object[])"/> methods log messages
- at the <c>WARN</c> level. That is the level with that name defined in the
- repositories <see cref="P:log4net.Repository.ILoggerRepository.LevelMap"/>. The default value
- for this level is <see cref="F:log4net.Core.Level.Warn"/>. The <see cref="P:log4net.Core.LogImpl.IsWarnEnabled"/>
- property tests if this level is enabled for logging.
- </description>
- </item>
- <item>
- <term>ERROR</term>
- <description>
- The <see cref="M:Error(object)"/> and <see cref="M:ErrorFormat(string, object[])"/> methods log messages
- at the <c>ERROR</c> level. That is the level with that name defined in the
- repositories <see cref="P:log4net.Repository.ILoggerRepository.LevelMap"/>. The default value
- for this level is <see cref="F:log4net.Core.Level.Error"/>. The <see cref="P:log4net.Core.LogImpl.IsErrorEnabled"/>
- property tests if this level is enabled for logging.
- </description>
- </item>
- <item>
- <term>FATAL</term>
- <description>
- The <see cref="M:Fatal(object)"/> and <see cref="M:FatalFormat(string, object[])"/> methods log messages
- at the <c>FATAL</c> level. That is the level with that name defined in the
- repositories <see cref="P:log4net.Repository.ILoggerRepository.LevelMap"/>. The default value
- for this level is <see cref="F:log4net.Core.Level.Fatal"/>. The <see cref="P:log4net.Core.LogImpl.IsFatalEnabled"/>
- property tests if this level is enabled for logging.
- </description>
- </item>
- </list>
- <para>
- The values for these levels and their semantic meanings can be changed by
- configuring the <see cref="P:log4net.Repository.ILoggerRepository.LevelMap"/> for the repository.
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- <author>Gert Driesen</author>
- </member>
- <member name="T:log4net.ILog">
- <summary>
- The ILog interface is use by application to log messages into
- the log4net framework.
- </summary>
- <remarks>
- <para>
- Use the <see cref="T:log4net.LogManager"/> to obtain logger instances
- that implement this interface. The <see cref="M:LogManager.GetLogger(Assembly,Type)"/>
- static method is used to get logger instances.
- </para>
- <para>
- This class contains methods for logging at different levels and also
- has properties for determining if those logging levels are
- enabled in the current configuration.
- </para>
- <para>
- This interface can be implemented in different ways. This documentation
- specifies reasonable behavior that a caller can expect from the actual
- implementation, however different implementations reserve the right to
- do things differently.
- </para>
- </remarks>
- <example>Simple example of logging messages
- <code lang="C#">
- ILog log = LogManager.GetLogger("application-log");
-
- log.Info("Application Start");
- log.Debug("This is a debug message");
-
- if (log.IsDebugEnabled)
- {
- log.Debug("This is another debug message");
- }
- </code>
- </example>
- <seealso cref="T:log4net.LogManager"/>
- <seealso cref="M:LogManager.GetLogger(Assembly, Type)"/>
- <author>Nicko Cadell</author>
- <author>Gert Driesen</author>
- </member>
- <member name="M:log4net.ILog.Debug(System.Object)">
- <overloads>Log a message object with the <see cref="F:log4net.Core.Level.Debug"/> level.</overloads>
- <summary>
- Log a message object with the <see cref="F:log4net.Core.Level.Debug"/> level.
- </summary>
- <param name="message">The message object to log.</param>
- <remarks>
- <para>
- This method first checks if this logger is <c>DEBUG</c>
- enabled by comparing the level of this logger with the
- <see cref="F:log4net.Core.Level.Debug"/> level. If this logger is
- <c>DEBUG</c> enabled, then it converts the message object
- (passed as parameter) to a string by invoking the appropriate
- <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then
- proceeds to call all the registered appenders in this logger
- and also higher in the hierarchy depending on the value of
- the additivity flag.
- </para>
- <para><b>WARNING</b> Note that passing an <see cref="T:System.Exception"/>
- to this method will print the name of the <see cref="T:System.Exception"/>
- but no stack trace. To print a stack trace use the
- <see cref="M:Debug(object,Exception)"/> form instead.
- </para>
- </remarks>
- <seealso cref="M:Debug(object,Exception)"/>
- <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
- </member>
- <member name="M:log4net.ILog.Debug(System.Object,System.Exception)">
- <summary>
- Log a message object with the <see cref="F:log4net.Core.Level.Debug"/> level including
- the stack trace of the <see cref="T:System.Exception"/> passed
- as a parameter.
- </summary>
- <param name="message">The message object to log.</param>
- <param name="exception">The exception to log, including its stack trace.</param>
- <remarks>
- <para>
- See the <see cref="M:Debug(object)"/> form for more detailed information.
- </para>
- </remarks>
- <seealso cref="M:Debug(object)"/>
- <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
- </member>
- <member name="M:log4net.ILog.DebugFormat(System.String,System.Object[])">
- <overloads>Log a formatted string with the <see cref="F:log4net.Core.Level.Debug"/> level.</overloads>
- <summary>
- Logs a formatted message string with the <see cref="F:log4net.Core.Level.Debug"/> level.
- </summary>
- <param name="format">A String containing zero or more format items</param>
- <param name="args">An Object array containing zero or more objects to format</param>
- <remarks>
- <para>
- The message is formatted using the <c>String.Format</c> method. See
- <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
- of the formatting.
- </para>
- <para>
- This method does not take an <see cref="T:System.Exception"/> object to include in the
- log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Debug(object,Exception)"/>
- methods instead.
- </para>
- </remarks>
- <seealso cref="M:Debug(object)"/>
- <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
- </member>
- <member name="M:log4net.ILog.DebugFormat(System.String,System.Object)">
- <summary>
- Logs a formatted message string with the <see cref="F:log4net.Core.Level.Debug"/> level.
- </summary>
- <param name="format">A String containing zero or more format items</param>
- <param name="arg0">An Object to format</param>
- <remarks>
- <para>
- The message is formatted using the <c>String.Format</c> method. See
- <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
- of the formatting.
- </para>
- <para>
- This method does not take an <see cref="T:System.Exception"/> object to include in the
- log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Debug(object,Exception)"/>
- methods instead.
- </para>
- </remarks>
- <seealso cref="M:Debug(object)"/>
- <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
- </member>
- <member name="M:log4net.ILog.DebugFormat(System.String,System.Object,System.Object)">
- <summary>
- Logs a formatted message string with the <see cref="F:log4net.Core.Level.Debug"/> level.
- </summary>
- <param name="format">A String containing zero or more format items</param>
- <param name="arg0">An Object to format</param>
- <param name="arg1">An Object to format</param>
- <remarks>
- <para>
- The message is formatted using the <c>String.Format</c> method. See
- <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
- of the formatting.
- </para>
- <para>
- This method does not take an <see cref="T:System.Exception"/> object to include in the
- log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Debug(object,Exception)"/>
- methods instead.
- </para>
- </remarks>
- <seealso cref="M:Debug(object)"/>
- <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
- </member>
- <member name="M:log4net.ILog.DebugFormat(System.String,System.Object,System.Object,System.Object)">
- <summary>
- Logs a formatted message string with the <see cref="F:log4net.Core.Level.Debug"/> level.
- </summary>
- <param name="format">A String containing zero or more format items</param>
- <param name="arg0">An Object to format</param>
- <param name="arg1">An Object to format</param>
- <param name="arg2">An Object to format</param>
- <remarks>
- <para>
- The message is formatted using the <c>String.Format</c> method. See
- <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
- of the formatting.
- </para>
- <para>
- This method does not take an <see cref="T:System.Exception"/> object to include in the
- log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Debug(object,Exception)"/>
- methods instead.
- </para>
- </remarks>
- <seealso cref="M:Debug(object)"/>
- <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
- </member>
- <member name="M:log4net.ILog.DebugFormat(System.IFormatProvider,System.String,System.Object[])">
- <summary>
- Logs a formatted message string with the <see cref="F:log4net.Core.Level.Debug"/> level.
- </summary>
- <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param>
- <param name="format">A String containing zero or more format items</param>
- <param name="args">An Object array containing zero or more objects to format</param>
- <remarks>
- <para>
- The message is formatted using the <c>String.Format</c> method. See
- <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
- of the formatting.
- </para>
- <para>
- This method does not take an <see cref="T:System.Exception"/> object to include in the
- log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Debug(object,Exception)"/>
- methods instead.
- </para>
- </remarks>
- <seealso cref="M:Debug(object)"/>
- <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
- </member>
- <member name="M:log4net.ILog.Info(System.Object)">
- <overloads>Log a message object with the <see cref="F:log4net.Core.Level.Info"/> level.</overloads>
- <summary>
- Logs a message object with the <see cref="F:log4net.Core.Level.Info"/> level.
- </summary>
- <remarks>
- <para>
- This method first checks if this logger is <c>INFO</c>
- enabled by comparing the level of this logger with the
- <see cref="F:log4net.Core.Level.Info"/> level. If this logger is
- <c>INFO</c> enabled, then it converts the message object
- (passed as parameter) to a string by invoking the appropriate
- <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then
- proceeds to call all the registered appenders in this logger
- and also higher in the hierarchy depending on the value of the
- additivity flag.
- </para>
- <para><b>WARNING</b> Note that passing an <see cref="T:System.Exception"/>
- to this method will print the name of the <see cref="T:System.Exception"/>
- but no stack trace. To print a stack trace use the
- <see cref="M:Info(object,Exception)"/> form instead.
- </para>
- </remarks>
- <param name="message">The message object to log.</param>
- <seealso cref="M:Info(object,Exception)"/>
- <seealso cref="P:log4net.ILog.IsInfoEnabled"/>
- </member>
- <member name="M:log4net.ILog.Info(System.Object,System.Exception)">
- <summary>
- Logs a message object with the <c>INFO</c> level including
- the stack trace of the <see cref="T:System.Exception"/> passed
- as a parameter.
- </summary>
- <param name="message">The message object to log.</param>
- <param name="exception">The exception to log, including its stack trace.</param>
- <remarks>
- <para>
- See the <see cref="M:Info(object)"/> form for more detailed information.
- </para>
- </remarks>
- <seealso cref="M:Info(object)"/>
- <seealso cref="P:log4net.ILog.IsInfoEnabled"/>
- </member>
- <member name="M:log4net.ILog.InfoFormat(System.String,System.Object[])">
- <overloads>Log a formatted message string with the <see cref="F:log4net.Core.Level.Info"/> level.</overloads>
- <summary>
- Logs a formatted message string with the <see cref="F:log4net.Core.Level.Info"/> level.
- </summary>
- <param name="format">A String containing zero or more format items</param>
- <param name="args">An Object array containing zero or more objects to format</param>
- <remarks>
- <para>
- The message is formatted using the <c>String.Format</c> method. See
- <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
- of the formatting.
- </para>
- <para>
- This method does not take an <see cref="T:System.Exception"/> object to include in the
- log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Info(object)"/>
- methods instead.
- </para>
- </remarks>
- <seealso cref="M:Info(object,Exception)"/>
- <seealso cref="P:log4net.ILog.IsInfoEnabled"/>
- </member>
- <member name="M:log4net.ILog.InfoFormat(System.String,System.Object)">
- <summary>
- Logs a formatted message string with the <see cref="F:log4net.Core.Level.Info"/> level.
- </summary>
- <param name="format">A String containing zero or more format items</param>
- <param name="arg0">An Object to format</param>
- <remarks>
- <para>
- The message is formatted using the <c>String.Format</c> method. See
- <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
- of the formatting.
- </para>
- <para>
- This method does not take an <see cref="T:System.Exception"/> object to include in the
- log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Info(object,Exception)"/>
- methods instead.
- </para>
- </remarks>
- <seealso cref="M:Info(object)"/>
- <seealso cref="P:log4net.ILog.IsInfoEnabled"/>
- </member>
- <member name="M:log4net.ILog.InfoFormat(System.String,System.Object,System.Object)">
- <summary>
- Logs a formatted message string with the <see cref="F:log4net.Core.Level.Info"/> level.
- </summary>
- <param name="format">A String containing zero or more format items</param>
- <param name="arg0">An Object to format</param>
- <param name="arg1">An Object to format</param>
- <remarks>
- <para>
- The message is formatted using the <c>String.Format</c> method. See
- <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
- of the formatting.
- </para>
- <para>
- This method does not take an <see cref="T:System.Exception"/> object to include in the
- log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Info(object,Exception)"/>
- methods instead.
- </para>
- </remarks>
- <seealso cref="M:Info(object)"/>
- <seealso cref="P:log4net.ILog.IsInfoEnabled"/>
- </member>
- <member name="M:log4net.ILog.InfoFormat(System.String,System.Object,System.Object,System.Object)">
- <summary>
- Logs a formatted message string with the <see cref="F:log4net.Core.Level.Info"/> level.
- </summary>
- <param name="format">A String containing zero or more format items</param>
- <param name="arg0">An Object to format</param>
- <param name="arg1">An Object to format</param>
- <param name="arg2">An Object to format</param>
- <remarks>
- <para>
- The message is formatted using the <c>String.Format</c> method. See
- <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
- of the formatting.
- </para>
- <para>
- This method does not take an <see cref="T:System.Exception"/> object to include in the
- log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Info(object,Exception)"/>
- methods instead.
- </para>
- </remarks>
- <seealso cref="M:Info(object)"/>
- <seealso cref="P:log4net.ILog.IsInfoEnabled"/>
- </member>
- <member name="M:log4net.ILog.InfoFormat(System.IFormatProvider,System.String,System.Object[])">
- <summary>
- Logs a formatted message string with the <see cref="F:log4net.Core.Level.Info"/> level.
- </summary>
- <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param>
- <param name="format">A String containing zero or more format items</param>
- <param name="args">An Object array containing zero or more objects to format</param>
- <remarks>
- <para>
- The message is formatted using the <c>String.Format</c> method. See
- <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
- of the formatting.
- </para>
- <para>
- This method does not take an <see cref="T:System.Exception"/> object to include in the
- log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Info(object)"/>
- methods instead.
- </para>
- </remarks>
- <seealso cref="M:Info(object,Exception)"/>
- <seealso cref="P:log4net.ILog.IsInfoEnabled"/>
- </member>
- <member name="M:log4net.ILog.Warn(System.Object)">
- <overloads>Log a message object with the <see cref="F:log4net.Core.Level.Warn"/> level.</overloads>
- <summary>
- Log a message object with the <see cref="F:log4net.Core.Level.Warn"/> level.
- </summary>
- <remarks>
- <para>
- This method first checks if this logger is <c>WARN</c>
- enabled by comparing the level of this logger with the
- <see cref="F:log4net.Core.Level.Warn"/> level. If this logger is
- <c>WARN</c> enabled, then it converts the message object
- (passed as parameter) to a string by invoking the appropriate
- <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then
- proceeds to call all the registered appenders in this logger
- and also higher in the hierarchy depending on the value of the
- additivity flag.
- </para>
- <para><b>WARNING</b> Note that passing an <see cref="T:System.Exception"/>
- to this method will print the name of the <see cref="T:System.Exception"/>
- but no stack trace. To print a stack trace use the
- <see cref="M:Warn(object,Exception)"/> form instead.
- </para>
- </remarks>
- <param name="message">The message object to log.</param>
- <seealso cref="M:Warn(object,Exception)"/>
- <seealso cref="P:log4net.ILog.IsWarnEnabled"/>
- </member>
- <member name="M:log4net.ILog.Warn(System.Object,System.Exception)">
- <summary>
- Log a message object with the <see cref="F:log4net.Core.Level.Warn"/> level including
- the stack trace of the <see cref="T:System.Exception"/> passed
- as a parameter.
- </summary>
- <param name="message">The message object to log.</param>
- <param name="exception">The exception to log, including its stack trace.</param>
- <remarks>
- <para>
- See the <see cref="M:Warn(object)"/> form for more detailed information.
- </para>
- </remarks>
- <seealso cref="M:Warn(object)"/>
- <seealso cref="P:log4net.ILog.IsWarnEnabled"/>
- </member>
- <member name="M:log4net.ILog.WarnFormat(System.String,System.Object[])">
- <overloads>Log a formatted message string with the <see cref="F:log4net.Core.Level.Warn"/> level.</overloads>
- <summary>
- Logs a formatted message string with the <see cref="F:log4net.Core.Level.Warn"/> level.
- </summary>
- <param name="format">A String containing zero or more format items</param>
- <param name="args">An Object array containing zero or more objects to format</param>
- <remarks>
- <para>
- The message is formatted using the <c>String.Format</c> method. See
- <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
- of the formatting.
- </para>
- <para>
- This method does not take an <see cref="T:System.Exception"/> object to include in the
- log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Warn(object)"/>
- methods instead.
- </para>
- </remarks>
- <seealso cref="M:Warn(object,Exception)"/>
- <seealso cref="P:log4net.ILog.IsWarnEnabled"/>
- </member>
- <member name="M:log4net.ILog.WarnFormat(System.String,System.Object)">
- <summary>
- Logs a formatted message string with the <see cref="F:log4net.Core.Level.Warn"/> level.
- </summary>
- <param name="format">A String containing zero or more format items</param>
- <param name="arg0">An Object to format</param>
- <remarks>
- <para>
- The message is formatted using the <c>String.Format</c> method. See
- <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
- of the formatting.
- </para>
- <para>
- This method does not take an <see cref="T:System.Exception"/> object to include in the
- log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Warn(object,Exception)"/>
- methods instead.
- </para>
- </remarks>
- <seealso cref="M:Warn(object)"/>
- <seealso cref="P:log4net.ILog.IsWarnEnabled"/>
- </member>
- <member name="M:log4net.ILog.WarnFormat(System.String,System.Object,System.Object)">
- <summary>
- Logs a formatted message string with the <see cref="F:log4net.Core.Level.Warn"/> level.
- </summary>
- <param name="format">A String containing zero or more format items</param>
- <param name="arg0">An Object to format</param>
- <param name="arg1">An Object to format</param>
- <remarks>
- <para>
- The message is formatted using the <c>String.Format</c> method. See
- <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
- of the formatting.
- </para>
- <para>
- This method does not take an <see cref="T:System.Exception"/> object to include in the
- log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Warn(object,Exception)"/>
- methods instead.
- </para>
- </remarks>
- <seealso cref="M:Warn(object)"/>
- <seealso cref="P:log4net.ILog.IsWarnEnabled"/>
- </member>
- <member name="M:log4net.ILog.WarnFormat(System.String,System.Object,System.Object,System.Object)">
- <summary>
- Logs a formatted message string with the <see cref="F:log4net.Core.Level.Warn"/> level.
- </summary>
- <param name="format">A String containing zero or more format items</param>
- <param name="arg0">An Object to format</param>
- <param name="arg1">An Object to format</param>
- <param name="arg2">An Object to format</param>
- <remarks>
- <para>
- The message is formatted using the <c>String.Format</c> method. See
- <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
- of the formatting.
- </para>
- <para>
- This method does not take an <see cref="T:System.Exception"/> object to include in the
- log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Warn(object,Exception)"/>
- methods instead.
- </para>
- </remarks>
- <seealso cref="M:Warn(object)"/>
- <seealso cref="P:log4net.ILog.IsWarnEnabled"/>
- </member>
- <member name="M:log4net.ILog.WarnFormat(System.IFormatProvider,System.String,System.Object[])">
- <summary>
- Logs a formatted message string with the <see cref="F:log4net.Core.Level.Warn"/> level.
- </summary>
- <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param>
- <param name="format">A String containing zero or more format items</param>
- <param name="args">An Object array containing zero or more objects to format</param>
- <remarks>
- <para>
- The message is formatted using the <c>String.Format</c> method. See
- <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
- of the formatting.
- </para>
- <para>
- This method does not take an <see cref="T:System.Exception"/> object to include in the
- log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Warn(object)"/>
- methods instead.
- </para>
- </remarks>
- <seealso cref="M:Warn(object,Exception)"/>
- <seealso cref="P:log4net.ILog.IsWarnEnabled"/>
- </member>
- <member name="M:log4net.ILog.Error(System.Object)">
- <overloads>Log a message object with the <see cref="F:log4net.Core.Level.Error"/> level.</overloads>
- <summary>
- Logs a message object with the <see cref="F:log4net.Core.Level.Error"/> level.
- </summary>
- <param name="message">The message object to log.</param>
- <remarks>
- <para>
- This method first checks if this logger is <c>ERROR</c>
- enabled by comparing the level of this logger with the
- <see cref="F:log4net.Core.Level.Error"/> level. If this logger is
- <c>ERROR</c> enabled, then it converts the message object
- (passed as parameter) to a string by invoking the appropriate
- <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then
- proceeds to call all the registered appenders in this logger
- and also higher in the hierarchy depending on the value of the
- additivity flag.
- </para>
- <para><b>WARNING</b> Note that passing an <see cref="T:System.Exception"/>
- to this method will print the name of the <see cref="T:System.Exception"/>
- but no stack trace. To print a stack trace use the
- <see cref="M:Error(object,Exception)"/> form instead.
- </para>
- </remarks>
- <seealso cref="M:Error(object,Exception)"/>
- <seealso cref="P:log4net.ILog.IsErrorEnabled"/>
- </member>
- <member name="M:log4net.ILog.Error(System.Object,System.Exception)">
- <summary>
- Log a message object with the <see cref="F:log4net.Core.Level.Error"/> level including
- the stack trace of the <see cref="T:System.Exception"/> passed
- as a parameter.
- </summary>
- <param name="message">The message object to log.</param>
- <param name="exception">The exception to log, including its stack trace.</param>
- <remarks>
- <para>
- See the <see cref="M:Error(object)"/> form for more detailed information.
- </para>
- </remarks>
- <seealso cref="M:Error(object)"/>
- <seealso cref="P:log4net.ILog.IsErrorEnabled"/>
- </member>
- <member name="M:log4net.ILog.ErrorFormat(System.String,System.Object[])">
- <overloads>Log a formatted message string with the <see cref="F:log4net.Core.Level.Error"/> level.</overloads>
- <summary>
- Logs a formatted message string with the <see cref="F:log4net.Core.Level.Error"/> level.
- </summary>
- <param name="format">A String containing zero or more format items</param>
- <param name="args">An Object array containing zero or more objects to format</param>
- <remarks>
- <para>
- The message is formatted using the <c>String.Format</c> method. See
- <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
- of the formatting.
- </para>
- <para>
- This method does not take an <see cref="T:System.Exception"/> object to include in the
- log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Error(object)"/>
- methods instead.
- </para>
- </remarks>
- <seealso cref="M:Error(object,Exception)"/>
- <seealso cref="P:log4net.ILog.IsErrorEnabled"/>
- </member>
- <member name="M:log4net.ILog.ErrorFormat(System.String,System.Object)">
- <summary>
- Logs a formatted message string with the <see cref="F:log4net.Core.Level.Error"/> level.
- </summary>
- <param name="format">A String containing zero or more format items</param>
- <param name="arg0">An Object to format</param>
- <remarks>
- <para>
- The message is formatted using the <c>String.Format</c> method. See
- <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
- of the formatting.
- </para>
- <para>
- This method does not take an <see cref="T:System.Exception"/> object to include in the
- log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Error(object,Exception)"/>
- methods instead.
- </para>
- </remarks>
- <seealso cref="M:Error(object)"/>
- <seealso cref="P:log4net.ILog.IsErrorEnabled"/>
- </member>
- <member name="M:log4net.ILog.ErrorFormat(System.String,System.Object,System.Object)">
- <summary>
- Logs a formatted message string with the <see cref="F:log4net.Core.Level.Error"/> level.
- </summary>
- <param name="format">A String containing zero or more format items</param>
- <param name="arg0">An Object to format</param>
- <param name="arg1">An Object to format</param>
- <remarks>
- <para>
- The message is formatted using the <c>String.Format</c> method. See
- <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
- of the formatting.
- </para>
- <para>
- This method does not take an <see cref="T:System.Exception"/> object to include in the
- log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Error(object,Exception)"/>
- methods instead.
- </para>
- </remarks>
- <seealso cref="M:Error(object)"/>
- <seealso cref="P:log4net.ILog.IsErrorEnabled"/>
- </member>
- <member name="M:log4net.ILog.ErrorFormat(System.String,System.Object,System.Object,System.Object)">
- <summary>
- Logs a formatted message string with the <see cref="F:log4net.Core.Level.Error"/> level.
- </summary>
- <param name="format">A String containing zero or more format items</param>
- <param name="arg0">An Object to format</param>
- <param name="arg1">An Object to format</param>
- <param name="arg2">An Object to format</param>
- <remarks>
- <para>
- The message is formatted using the <c>String.Format</c> method. See
- <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
- of the formatting.
- </para>
- <para>
- This method does not take an <see cref="T:System.Exception"/> object to include in the
- log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Error(object,Exception)"/>
- methods instead.
- </para>
- </remarks>
- <seealso cref="M:Error(object)"/>
- <seealso cref="P:log4net.ILog.IsErrorEnabled"/>
- </member>
- <member name="M:log4net.ILog.ErrorFormat(System.IFormatProvider,System.String,System.Object[])">
- <summary>
- Logs a formatted message string with the <see cref="F:log4net.Core.Level.Error"/> level.
- </summary>
- <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param>
- <param name="format">A String containing zero or more format items</param>
- <param name="args">An Object array containing zero or more objects to format</param>
- <remarks>
- <para>
- The message is formatted using the <c>String.Format</c> method. See
- <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
- of the formatting.
- </para>
- <para>
- This method does not take an <see cref="T:System.Exception"/> object to include in the
- log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Error(object)"/>
- methods instead.
- </para>
- </remarks>
- <seealso cref="M:Error(object,Exception)"/>
- <seealso cref="P:log4net.ILog.IsErrorEnabled"/>
- </member>
- <member name="M:log4net.ILog.Fatal(System.Object)">
- <overloads>Log a message object with the <see cref="F:log4net.Core.Level.Fatal"/> level.</overloads>
- <summary>
- Log a message object with the <see cref="F:log4net.Core.Level.Fatal"/> level.
- </summary>
- <remarks>
- <para>
- This method first checks if this logger is <c>FATAL</c>
- enabled by comparing the level of this logger with the
- <see cref="F:log4net.Core.Level.Fatal"/> level. If this logger is
- <c>FATAL</c> enabled, then it converts the message object
- (passed as parameter) to a string by invoking the appropriate
- <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then
- proceeds to call all the registered appenders in this logger
- and also higher in the hierarchy depending on the value of the
- additivity flag.
- </para>
- <para><b>WARNING</b> Note that passing an <see cref="T:System.Exception"/>
- to this method will print the name of the <see cref="T:System.Exception"/>
- but no stack trace. To print a stack trace use the
- <see cref="M:Fatal(object,Exception)"/> form instead.
- </para>
- </remarks>
- <param name="message">The message object to log.</param>
- <seealso cref="M:Fatal(object,Exception)"/>
- <seealso cref="P:log4net.ILog.IsFatalEnabled"/>
- </member>
- <member name="M:log4net.ILog.Fatal(System.Object,System.Exception)">
- <summary>
- Log a message object with the <see cref="F:log4net.Core.Level.Fatal"/> level including
- the stack trace of the <see cref="T:System.Exception"/> passed
- as a parameter.
- </summary>
- <param name="message">The message object to log.</param>
- <param name="exception">The exception to log, including its stack trace.</param>
- <remarks>
- <para>
- See the <see cref="M:Fatal(object)"/> form for more detailed information.
- </para>
- </remarks>
- <seealso cref="M:Fatal(object)"/>
- <seealso cref="P:log4net.ILog.IsFatalEnabled"/>
- </member>
- <member name="M:log4net.ILog.FatalFormat(System.String,System.Object[])">
- <overloads>Log a formatted message string with the <see cref="F:log4net.Core.Level.Fatal"/> level.</overloads>
- <summary>
- Logs a formatted message string with the <see cref="F:log4net.Core.Level.Fatal"/> level.
- </summary>
- <param name="format">A String containing zero or more format items</param>
- <param name="args">An Object array containing zero or more objects to format</param>
- <remarks>
- <para>
- The message is formatted using the <c>String.Format</c> method. See
- <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
- of the formatting.
- </para>
- <para>
- This method does not take an <see cref="T:System.Exception"/> object to include in the
- log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Fatal(object)"/>
- methods instead.
- </para>
- </remarks>
- <seealso cref="M:Fatal(object,Exception)"/>
- <seealso cref="P:log4net.ILog.IsFatalEnabled"/>
- </member>
- <member name="M:log4net.ILog.FatalFormat(System.String,System.Object)">
- <summary>
- Logs a formatted message string with the <see cref="F:log4net.Core.Level.Fatal"/> level.
- </summary>
- <param name="format">A String containing zero or more format items</param>
- <param name="arg0">An Object to format</param>
- <remarks>
- <para>
- The message is formatted using the <c>String.Format</c> method. See
- <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
- of the formatting.
- </para>
- <para>
- This method does not take an <see cref="T:System.Exception"/> object to include in the
- log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Fatal(object,Exception)"/>
- methods instead.
- </para>
- </remarks>
- <seealso cref="M:Fatal(object)"/>
- <seealso cref="P:log4net.ILog.IsFatalEnabled"/>
- </member>
- <member name="M:log4net.ILog.FatalFormat(System.String,System.Object,System.Object)">
- <summary>
- Logs a formatted message string with the <see cref="F:log4net.Core.Level.Fatal"/> level.
- </summary>
- <param name="format">A String containing zero or more format items</param>
- <param name="arg0">An Object to format</param>
- <param name="arg1">An Object to format</param>
- <remarks>
- <para>
- The message is formatted using the <c>String.Format</c> method. See
- <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
- of the formatting.
- </para>
- <para>
- This method does not take an <see cref="T:System.Exception"/> object to include in the
- log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Fatal(object,Exception)"/>
- methods instead.
- </para>
- </remarks>
- <seealso cref="M:Fatal(object)"/>
- <seealso cref="P:log4net.ILog.IsFatalEnabled"/>
- </member>
- <member name="M:log4net.ILog.FatalFormat(System.String,System.Object,System.Object,System.Object)">
- <summary>
- Logs a formatted message string with the <see cref="F:log4net.Core.Level.Fatal"/> level.
- </summary>
- <param name="format">A String containing zero or more format items</param>
- <param name="arg0">An Object to format</param>
- <param name="arg1">An Object to format</param>
- <param name="arg2">An Object to format</param>
- <remarks>
- <para>
- The message is formatted using the <c>String.Format</c> method. See
- <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
- of the formatting.
- </para>
- <para>
- This method does not take an <see cref="T:System.Exception"/> object to include in the
- log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Fatal(object,Exception)"/>
- methods instead.
- </para>
- </remarks>
- <seealso cref="M:Fatal(object)"/>
- <seealso cref="P:log4net.ILog.IsFatalEnabled"/>
- </member>
- <member name="M:log4net.ILog.FatalFormat(System.IFormatProvider,System.String,System.Object[])">
- <summary>
- Logs a formatted message string with the <see cref="F:log4net.Core.Level.Fatal"/> level.
- </summary>
- <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param>
- <param name="format">A String containing zero or more format items</param>
- <param name="args">An Object array containing zero or more objects to format</param>
- <remarks>
- <para>
- The message is formatted using the <c>String.Format</c> method. See
- <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
- of the formatting.
- </para>
- <para>
- This method does not take an <see cref="T:System.Exception"/> object to include in the
- log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Fatal(object)"/>
- methods instead.
- </para>
- </remarks>
- <seealso cref="M:Fatal(object,Exception)"/>
- <seealso cref="P:log4net.ILog.IsFatalEnabled"/>
- </member>
- <member name="P:log4net.ILog.IsDebugEnabled">
- <summary>
- Checks if this logger is enabled for the <see cref="F:log4net.Core.Level.Debug"/> level.
- </summary>
- <value>
- <c>true</c> if this logger is enabled for <see cref="F:log4net.Core.Level.Debug"/> events, <c>false</c> otherwise.
- </value>
- <remarks>
- <para>
- This function is intended to lessen the computational cost of
- disabled log debug statements.
- </para>
- <para> For some ILog interface <c>log</c>, when you write:</para>
- <code lang="C#">
- log.Debug("This is entry number: " + i );
- </code>
- <para>
- You incur the cost constructing the message, string construction and concatenation in
- this case, regardless of whether the message is logged or not.
- </para>
- <para>
- If you are worried about speed (who isn't), then you should write:
- </para>
- <code lang="C#">
- if (log.IsDebugEnabled)
- {
- log.Debug("This is entry number: " + i );
- }
- </code>
- <para>
- This way you will not incur the cost of parameter
- construction if debugging is disabled for <c>log</c>. On
- the other hand, if the <c>log</c> is debug enabled, you
- will incur the cost of evaluating whether the logger is debug
- enabled twice. Once in <see cref="P:log4net.ILog.IsDebugEnabled"/> and once in
- the <see cref="M:Debug(object)"/>. This is an insignificant overhead
- since evaluating a logger takes about 1% of the time it
- takes to actually log. This is the preferred style of logging.
- </para>
- <para>Alternatively if your logger is available statically then the is debug
- enabled state can be stored in a static variable like this:
- </para>
- <code lang="C#">
- private static readonly bool isDebugEnabled = log.IsDebugEnabled;
- </code>
- <para>
- Then when you come to log you can write:
- </para>
- <code lang="C#">
- if (isDebugEnabled)
- {
- log.Debug("This is entry number: " + i );
- }
- </code>
- <para>
- This way the debug enabled state is only queried once
- when the class is loaded. Using a <c>private static readonly</c>
- variable is the most efficient because it is a run time constant
- and can be heavily optimized by the JIT compiler.
- </para>
- <para>
- Of course if you use a static readonly variable to
- hold the enabled state of the logger then you cannot
- change the enabled state at runtime to vary the logging
- that is produced. You have to decide if you need absolute
- speed or runtime flexibility.
- </para>
- </remarks>
- <seealso cref="M:Debug(object)"/>
- <seealso cref="M:DebugFormat(IFormatProvider, string, object[])"/>
- </member>
- <member name="P:log4net.ILog.IsInfoEnabled">
- <summary>
- Checks if this logger is enabled for the <see cref="F:log4net.Core.Level.Info"/> level.
- </summary>
- <value>
- <c>true</c> if this logger is enabled for <see cref="F:log4net.Core.Level.Info"/> events, <c>false</c> otherwise.
- </value>
- <remarks>
- For more information see <see cref="P:log4net.ILog.IsDebugEnabled"/>.
- </remarks>
- <seealso cref="M:Info(object)"/>
- <seealso cref="M:InfoFormat(IFormatProvider, string, object[])"/>
- <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
- </member>
- <member name="P:log4net.ILog.IsWarnEnabled">
- <summary>
- Checks if this logger is enabled for the <see cref="F:log4net.Core.Level.Warn"/> level.
- </summary>
- <value>
- <c>true</c> if this logger is enabled for <see cref="F:log4net.Core.Level.Warn"/> events, <c>false</c> otherwise.
- </value>
- <remarks>
- For more information see <see cref="P:log4net.ILog.IsDebugEnabled"/>.
- </remarks>
- <seealso cref="M:Warn(object)"/>
- <seealso cref="M:WarnFormat(IFormatProvider, string, object[])"/>
- <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
- </member>
- <member name="P:log4net.ILog.IsErrorEnabled">
- <summary>
- Checks if this logger is enabled for the <see cref="F:log4net.Core.Level.Error"/> level.
- </summary>
- <value>
- <c>true</c> if this logger is enabled for <see cref="F:log4net.Core.Level.Error"/> events, <c>false</c> otherwise.
- </value>
- <remarks>
- For more information see <see cref="P:log4net.ILog.IsDebugEnabled"/>.
- </remarks>
- <seealso cref="M:Error(object)"/>
- <seealso cref="M:ErrorFormat(IFormatProvider, string, object[])"/>
- <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
- </member>
- <member name="P:log4net.ILog.IsFatalEnabled">
- <summary>
- Checks if this logger is enabled for the <see cref="F:log4net.Core.Level.Fatal"/> level.
- </summary>
- <value>
- <c>true</c> if this logger is enabled for <see cref="F:log4net.Core.Level.Fatal"/> events, <c>false</c> otherwise.
- </value>
- <remarks>
- For more information see <see cref="P:log4net.ILog.IsDebugEnabled"/>.
- </remarks>
- <seealso cref="M:Fatal(object)"/>
- <seealso cref="M:FatalFormat(IFormatProvider, string, object[])"/>
- <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
- </member>
- <member name="M:log4net.Core.LogImpl.#ctor(log4net.Core.ILogger)">
- <summary>
- Construct a new wrapper for the specified logger.
- </summary>
- <param name="logger">The logger to wrap.</param>
- <remarks>
- <para>
- Construct a new wrapper for the specified logger.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Core.LogImpl.ReloadLevels(log4net.Repository.ILoggerRepository)">
- <summary>
- Virtual method called when the configuration of the repository changes
- </summary>
- <param name="repository">the repository holding the levels</param>
- <remarks>
- <para>
- Virtual method called when the configuration of the repository changes
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Core.LogImpl.Debug(System.Object)">
- <summary>
- Logs a message object with the <c>DEBUG</c> level.
- </summary>
- <param name="message">The message object to log.</param>
- <remarks>
- <para>
- This method first checks if this logger is <c>DEBUG</c>
- enabled by comparing the level of this logger with the
- <c>DEBUG</c> level. If this logger is
- <c>DEBUG</c> enabled, then it converts the message object
- (passed as parameter) to a string by invoking the appropriate
- <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then
- proceeds to call all the registered appenders in this logger
- and also higher in the hierarchy depending on the value of the
- additivity flag.
- </para>
- <para>
- <b>WARNING</b> Note that passing an <see cref="T:System.Exception"/>
- to this method will print the name of the <see cref="T:System.Exception"/>
- but no stack trace. To print a stack trace use the
- <see cref="M:Debug(object,Exception)"/> form instead.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Core.LogImpl.Debug(System.Object,System.Exception)">
- <summary>
- Logs a message object with the <c>DEBUG</c> level
- </summary>
- <param name="message">The message object to log.</param>
- <param name="exception">The exception to log, including its stack trace.</param>
- <remarks>
- <para>
- Logs a message object with the <c>DEBUG</c> level including
- the stack trace of the <see cref="T:System.Exception"/> <paramref name="exception"/> passed
- as a parameter.
- </para>
- <para>
- See the <see cref="M:Debug(object)"/> form for more detailed information.
- </para>
- </remarks>
- <seealso cref="M:Debug(object)"/>
- </member>
- <member name="M:log4net.Core.LogImpl.DebugFormat(System.String,System.Object[])">
- <summary>
- Logs a formatted message string with the <c>DEBUG</c> level.
- </summary>
- <param name="format">A String containing zero or more format items</param>
- <param name="args">An Object array containing zero or more objects to format</param>
- <remarks>
- <para>
- The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
- <c>String.Format</c> for details of the syntax of the format string and the behavior
- of the formatting.
- </para>
- <para>
- The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
- format provider. To specify a localized provider use the
- <see cref="M:DebugFormat(IFormatProvider,string,object[])"/> method.
- </para>
- <para>
- This method does not take an <see cref="T:System.Exception"/> object to include in the
- log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Debug(object)"/>
- methods instead.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Core.LogImpl.DebugFormat(System.String,System.Object)">
- <summary>
- Logs a formatted message string with the <c>DEBUG</c> level.
- </summary>
- <param name="format">A String containing zero or more format items</param>
- <param name="arg0">An Object to format</param>
- <remarks>
- <para>
- The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
- <c>String.Format</c> for details of the syntax of the format string and the behavior
- of the formatting.
- </para>
- <para>
- The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
- format provider. To specify a localized provider use the
- <see cref="M:DebugFormat(IFormatProvider,string,object[])"/> method.
- </para>
- <para>
- This method does not take an <see cref="T:System.Exception"/> object to include in the
- log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Debug(object)"/>
- methods instead.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Core.LogImpl.DebugFormat(System.String,System.Object,System.Object)">
- <summary>
- Logs a formatted message string with the <c>DEBUG</c> level.
- </summary>
- <param name="format">A String containing zero or more format items</param>
- <param name="arg0">An Object to format</param>
- <param name="arg1">An Object to format</param>
- <remarks>
- <para>
- The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
- <c>String.Format</c> for details of the syntax of the format string and the behavior
- of the formatting.
- </para>
- <para>
- The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
- format provider. To specify a localized provider use the
- <see cref="M:DebugFormat(IFormatProvider,string,object[])"/> method.
- </para>
- <para>
- This method does not take an <see cref="T:System.Exception"/> object to include in the
- log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Debug(object)"/>
- methods instead.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Core.LogImpl.DebugFormat(System.String,System.Object,System.Object,System.Object)">
- <summary>
- Logs a formatted message string with the <c>DEBUG</c> level.
- </summary>
- <param name="format">A String containing zero or more format items</param>
- <param name="arg0">An Object to format</param>
- <param name="arg1">An Object to format</param>
- <param name="arg2">An Object to format</param>
- <remarks>
- <para>
- The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
- <c>String.Format</c> for details of the syntax of the format string and the behavior
- of the formatting.
- </para>
- <para>
- The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
- format provider. To specify a localized provider use the
- <see cref="M:DebugFormat(IFormatProvider,string,object[])"/> method.
- </para>
- <para>
- This method does not take an <see cref="T:System.Exception"/> object to include in the
- log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Debug(object)"/>
- methods instead.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Core.LogImpl.DebugFormat(System.IFormatProvider,System.String,System.Object[])">
- <summary>
- Logs a formatted message string with the <c>DEBUG</c> level.
- </summary>
- <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param>
- <param name="format">A String containing zero or more format items</param>
- <param name="args">An Object array containing zero or more objects to format</param>
- <remarks>
- <para>
- The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
- <c>String.Format</c> for details of the syntax of the format string and the behavior
- of the formatting.
- </para>
- <para>
- This method does not take an <see cref="T:System.Exception"/> object to include in the
- log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Debug(object)"/>
- methods instead.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Core.LogImpl.Info(System.Object)">
- <summary>
- Logs a message object with the <c>INFO</c> level.
- </summary>
- <param name="message">The message object to log.</param>
- <remarks>
- <para>
- This method first checks if this logger is <c>INFO</c>
- enabled by comparing the level of this logger with the
- <c>INFO</c> level. If this logger is
- <c>INFO</c> enabled, then it converts the message object
- (passed as parameter) to a string by invoking the appropriate
- <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then
- proceeds to call all the registered appenders in this logger
- and also higher in the hierarchy depending on the value of
- the additivity flag.
- </para>
- <para>
- <b>WARNING</b> Note that passing an <see cref="T:System.Exception"/>
- to this method will print the name of the <see cref="T:System.Exception"/>
- but no stack trace. To print a stack trace use the
- <see cref="M:Info(object,Exception)"/> form instead.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Core.LogImpl.Info(System.Object,System.Exception)">
- <summary>
- Logs a message object with the <c>INFO</c> level.
- </summary>
- <param name="message">The message object to log.</param>
- <param name="exception">The exception to log, including its stack trace.</param>
- <remarks>
- <para>
- Logs a message object with the <c>INFO</c> level including
- the stack trace of the <see cref="T:System.Exception"/> <paramref name="exception"/>
- passed as a parameter.
- </para>
- <para>
- See the <see cref="M:Info(object)"/> form for more detailed information.
- </para>
- </remarks>
- <seealso cref="M:Info(object)"/>
- </member>
- <member name="M:log4net.Core.LogImpl.InfoFormat(System.String,System.Object[])">
- <summary>
- Logs a formatted message string with the <c>INFO</c> level.
- </summary>
- <param name="format">A String containing zero or more format items</param>
- <param name="args">An Object array containing zero or more objects to format</param>
- <remarks>
- <para>
- The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
- <c>String.Format</c> for details of the syntax of the format string and the behavior
- of the formatting.
- </para>
- <para>
- The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
- format provider. To specify a localized provider use the
- <see cref="M:InfoFormat(IFormatProvider,string,object[])"/> method.
- </para>
- <para>
- This method does not take an <see cref="T:System.Exception"/> object to include in the
- log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Info(object)"/>
- methods instead.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Core.LogImpl.InfoFormat(System.String,System.Object)">
- <summary>
- Logs a formatted message string with the <c>INFO</c> level.
- </summary>
- <param name="format">A String containing zero or more format items</param>
- <param name="arg0">An Object to format</param>
- <remarks>
- <para>
- The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
- <c>String.Format</c> for details of the syntax of the format string and the behavior
- of the formatting.
- </para>
- <para>
- The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
- format provider. To specify a localized provider use the
- <see cref="M:InfoFormat(IFormatProvider,string,object[])"/> method.
- </para>
- <para>
- This method does not take an <see cref="T:System.Exception"/> object to include in the
- log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Info(object)"/>
- methods instead.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Core.LogImpl.InfoFormat(System.String,System.Object,System.Object)">
- <summary>
- Logs a formatted message string with the <c>INFO</c> level.
- </summary>
- <param name="format">A String containing zero or more format items</param>
- <param name="arg0">An Object to format</param>
- <param name="arg1">An Object to format</param>
- <remarks>
- <para>
- The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
- <c>String.Format</c> for details of the syntax of the format string and the behavior
- of the formatting.
- </para>
- <para>
- The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
- format provider. To specify a localized provider use the
- <see cref="M:InfoFormat(IFormatProvider,string,object[])"/> method.
- </para>
- <para>
- This method does not take an <see cref="T:System.Exception"/> object to include in the
- log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Info(object)"/>
- methods instead.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Core.LogImpl.InfoFormat(System.String,System.Object,System.Object,System.Object)">
- <summary>
- Logs a formatted message string with the <c>INFO</c> level.
- </summary>
- <param name="format">A String containing zero or more format items</param>
- <param name="arg0">An Object to format</param>
- <param name="arg1">An Object to format</param>
- <param name="arg2">An Object to format</param>
- <remarks>
- <para>
- The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
- <c>String.Format</c> for details of the syntax of the format string and the behavior
- of the formatting.
- </para>
- <para>
- The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
- format provider. To specify a localized provider use the
- <see cref="M:InfoFormat(IFormatProvider,string,object[])"/> method.
- </para>
- <para>
- This method does not take an <see cref="T:System.Exception"/> object to include in the
- log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Info(object)"/>
- methods instead.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Core.LogImpl.InfoFormat(System.IFormatProvider,System.String,System.Object[])">
- <summary>
- Logs a formatted message string with the <c>INFO</c> level.
- </summary>
- <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param>
- <param name="format">A String containing zero or more format items</param>
- <param name="args">An Object array containing zero or more objects to format</param>
- <remarks>
- <para>
- The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
- <c>String.Format</c> for details of the syntax of the format string and the behavior
- of the formatting.
- </para>
- <para>
- This method does not take an <see cref="T:System.Exception"/> object to include in the
- log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Info(object)"/>
- methods instead.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Core.LogImpl.Warn(System.Object)">
- <summary>
- Logs a message object with the <c>WARN</c> level.
- </summary>
- <param name="message">the message object to log</param>
- <remarks>
- <para>
- This method first checks if this logger is <c>WARN</c>
- enabled by comparing the level of this logger with the
- <c>WARN</c> level. If this logger is
- <c>WARN</c> enabled, then it converts the message object
- (passed as parameter) to a string by invoking the appropriate
- <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then
- proceeds to call all the registered appenders in this logger and
- also higher in the hierarchy depending on the value of the
- additivity flag.
- </para>
- <para>
- <b>WARNING</b> Note that passing an <see cref="T:System.Exception"/> to this
- method will print the name of the <see cref="T:System.Exception"/> but no
- stack trace. To print a stack trace use the
- <see cref="M:Warn(object,Exception)"/> form instead.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Core.LogImpl.Warn(System.Object,System.Exception)">
- <summary>
- Logs a message object with the <c>WARN</c> level
- </summary>
- <param name="message">The message object to log.</param>
- <param name="exception">The exception to log, including its stack trace.</param>
- <remarks>
- <para>
- Logs a message object with the <c>WARN</c> level including
- the stack trace of the <see cref="T:System.Exception"/> <paramref name="exception"/>
- passed as a parameter.
- </para>
- <para>
- See the <see cref="M:Warn(object)"/> form for more detailed information.
- </para>
- </remarks>
- <seealso cref="M:Warn(object)"/>
- </member>
- <member name="M:log4net.Core.LogImpl.WarnFormat(System.String,System.Object[])">
- <summary>
- Logs a formatted message string with the <c>WARN</c> level.
- </summary>
- <param name="format">A String containing zero or more format items</param>
- <param name="args">An Object array containing zero or more objects to format</param>
- <remarks>
- <para>
- The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
- <c>String.Format</c> for details of the syntax of the format string and the behavior
- of the formatting.
- </para>
- <para>
- The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
- format provider. To specify a localized provider use the
- <see cref="M:WarnFormat(IFormatProvider,string,object[])"/> method.
- </para>
- <para>
- This method does not take an <see cref="T:System.Exception"/> object to include in the
- log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Warn(object)"/>
- methods instead.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Core.LogImpl.WarnFormat(System.String,System.Object)">
- <summary>
- Logs a formatted message string with the <c>WARN</c> level.
- </summary>
- <param name="format">A String containing zero or more format items</param>
- <param name="arg0">An Object to format</param>
- <remarks>
- <para>
- The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
- <c>String.Format</c> for details of the syntax of the format string and the behavior
- of the formatting.
- </para>
- <para>
- The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
- format provider. To specify a localized provider use the
- <see cref="M:WarnFormat(IFormatProvider,string,object[])"/> method.
- </para>
- <para>
- This method does not take an <see cref="T:System.Exception"/> object to include in the
- log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Warn(object)"/>
- methods instead.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Core.LogImpl.WarnFormat(System.String,System.Object,System.Object)">
- <summary>
- Logs a formatted message string with the <c>WARN</c> level.
- </summary>
- <param name="format">A String containing zero or more format items</param>
- <param name="arg0">An Object to format</param>
- <param name="arg1">An Object to format</param>
- <remarks>
- <para>
- The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
- <c>String.Format</c> for details of the syntax of the format string and the behavior
- of the formatting.
- </para>
- <para>
- The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
- format provider. To specify a localized provider use the
- <see cref="M:WarnFormat(IFormatProvider,string,object[])"/> method.
- </para>
- <para>
- This method does not take an <see cref="T:System.Exception"/> object to include in the
- log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Warn(object)"/>
- methods instead.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Core.LogImpl.WarnFormat(System.String,System.Object,System.Object,System.Object)">
- <summary>
- Logs a formatted message string with the <c>WARN</c> level.
- </summary>
- <param name="format">A String containing zero or more format items</param>
- <param name="arg0">An Object to format</param>
- <param name="arg1">An Object to format</param>
- <param name="arg2">An Object to format</param>
- <remarks>
- <para>
- The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
- <c>String.Format</c> for details of the syntax of the format string and the behavior
- of the formatting.
- </para>
- <para>
- The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
- format provider. To specify a localized provider use the
- <see cref="M:WarnFormat(IFormatProvider,string,object[])"/> method.
- </para>
- <para>
- This method does not take an <see cref="T:System.Exception"/> object to include in the
- log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Warn(object)"/>
- methods instead.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Core.LogImpl.WarnFormat(System.IFormatProvider,System.String,System.Object[])">
- <summary>
- Logs a formatted message string with the <c>WARN</c> level.
- </summary>
- <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param>
- <param name="format">A String containing zero or more format items</param>
- <param name="args">An Object array containing zero or more objects to format</param>
- <remarks>
- <para>
- The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
- <c>String.Format</c> for details of the syntax of the format string and the behavior
- of the formatting.
- </para>
- <para>
- This method does not take an <see cref="T:System.Exception"/> object to include in the
- log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Warn(object)"/>
- methods instead.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Core.LogImpl.Error(System.Object)">
- <summary>
- Logs a message object with the <c>ERROR</c> level.
- </summary>
- <param name="message">The message object to log.</param>
- <remarks>
- <para>
- This method first checks if this logger is <c>ERROR</c>
- enabled by comparing the level of this logger with the
- <c>ERROR</c> level. If this logger is
- <c>ERROR</c> enabled, then it converts the message object
- (passed as parameter) to a string by invoking the appropriate
- <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then
- proceeds to call all the registered appenders in this logger and
- also higher in the hierarchy depending on the value of the
- additivity flag.
- </para>
- <para>
- <b>WARNING</b> Note that passing an <see cref="T:System.Exception"/> to this
- method will print the name of the <see cref="T:System.Exception"/> but no
- stack trace. To print a stack trace use the
- <see cref="M:Error(object,Exception)"/> form instead.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Core.LogImpl.Error(System.Object,System.Exception)">
- <summary>
- Logs a message object with the <c>ERROR</c> level
- </summary>
- <param name="message">The message object to log.</param>
- <param name="exception">The exception to log, including its stack trace.</param>
- <remarks>
- <para>
- Logs a message object with the <c>ERROR</c> level including
- the stack trace of the <see cref="T:System.Exception"/> <paramref name="exception"/>
- passed as a parameter.
- </para>
- <para>
- See the <see cref="M:Error(object)"/> form for more detailed information.
- </para>
- </remarks>
- <seealso cref="M:Error(object)"/>
- </member>
- <member name="M:log4net.Core.LogImpl.ErrorFormat(System.String,System.Object[])">
- <summary>
- Logs a formatted message string with the <c>ERROR</c> level.
- </summary>
- <param name="format">A String containing zero or more format items</param>
- <param name="args">An Object array containing zero or more objects to format</param>
- <remarks>
- <para>
- The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
- <c>String.Format</c> for details of the syntax of the format string and the behavior
- of the formatting.
- </para>
- <para>
- The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
- format provider. To specify a localized provider use the
- <see cref="M:ErrorFormat(IFormatProvider,string,object[])"/> method.
- </para>
- <para>
- This method does not take an <see cref="T:System.Exception"/> object to include in the
- log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Error(object)"/>
- methods instead.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Core.LogImpl.ErrorFormat(System.String,System.Object)">
- <summary>
- Logs a formatted message string with the <c>ERROR</c> level.
- </summary>
- <param name="format">A String containing zero or more format items</param>
- <param name="arg0">An Object to format</param>
- <remarks>
- <para>
- The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
- <c>String.Format</c> for details of the syntax of the format string and the behavior
- of the formatting.
- </para>
- <para>
- The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
- format provider. To specify a localized provider use the
- <see cref="M:ErrorFormat(IFormatProvider,string,object[])"/> method.
- </para>
- <para>
- This method does not take an <see cref="T:System.Exception"/> object to include in the
- log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Error(object)"/>
- methods instead.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Core.LogImpl.ErrorFormat(System.String,System.Object,System.Object)">
- <summary>
- Logs a formatted message string with the <c>ERROR</c> level.
- </summary>
- <param name="format">A String containing zero or more format items</param>
- <param name="arg0">An Object to format</param>
- <param name="arg1">An Object to format</param>
- <remarks>
- <para>
- The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
- <c>String.Format</c> for details of the syntax of the format string and the behavior
- of the formatting.
- </para>
- <para>
- The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
- format provider. To specify a localized provider use the
- <see cref="M:ErrorFormat(IFormatProvider,string,object[])"/> method.
- </para>
- <para>
- This method does not take an <see cref="T:System.Exception"/> object to include in the
- log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Error(object)"/>
- methods instead.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Core.LogImpl.ErrorFormat(System.String,System.Object,System.Object,System.Object)">
- <summary>
- Logs a formatted message string with the <c>ERROR</c> level.
- </summary>
- <param name="format">A String containing zero or more format items</param>
- <param name="arg0">An Object to format</param>
- <param name="arg1">An Object to format</param>
- <param name="arg2">An Object to format</param>
- <remarks>
- <para>
- The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
- <c>String.Format</c> for details of the syntax of the format string and the behavior
- of the formatting.
- </para>
- <para>
- The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
- format provider. To specify a localized provider use the
- <see cref="M:ErrorFormat(IFormatProvider,string,object[])"/> method.
- </para>
- <para>
- This method does not take an <see cref="T:System.Exception"/> object to include in the
- log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Error(object)"/>
- methods instead.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Core.LogImpl.ErrorFormat(System.IFormatProvider,System.String,System.Object[])">
- <summary>
- Logs a formatted message string with the <c>ERROR</c> level.
- </summary>
- <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param>
- <param name="format">A String containing zero or more format items</param>
- <param name="args">An Object array containing zero or more objects to format</param>
- <remarks>
- <para>
- The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
- <c>String.Format</c> for details of the syntax of the format string and the behavior
- of the formatting.
- </para>
- <para>
- This method does not take an <see cref="T:System.Exception"/> object to include in the
- log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Error(object)"/>
- methods instead.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Core.LogImpl.Fatal(System.Object)">
- <summary>
- Logs a message object with the <c>FATAL</c> level.
- </summary>
- <param name="message">The message object to log.</param>
- <remarks>
- <para>
- This method first checks if this logger is <c>FATAL</c>
- enabled by comparing the level of this logger with the
- <c>FATAL</c> level. If this logger is
- <c>FATAL</c> enabled, then it converts the message object
- (passed as parameter) to a string by invoking the appropriate
- <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then
- proceeds to call all the registered appenders in this logger and
- also higher in the hierarchy depending on the value of the
- additivity flag.
- </para>
- <para>
- <b>WARNING</b> Note that passing an <see cref="T:System.Exception"/> to this
- method will print the name of the <see cref="T:System.Exception"/> but no
- stack trace. To print a stack trace use the
- <see cref="M:Fatal(object,Exception)"/> form instead.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Core.LogImpl.Fatal(System.Object,System.Exception)">
- <summary>
- Logs a message object with the <c>FATAL</c> level
- </summary>
- <param name="message">The message object to log.</param>
- <param name="exception">The exception to log, including its stack trace.</param>
- <remarks>
- <para>
- Logs a message object with the <c>FATAL</c> level including
- the stack trace of the <see cref="T:System.Exception"/> <paramref name="exception"/>
- passed as a parameter.
- </para>
- <para>
- See the <see cref="M:Fatal(object)"/> form for more detailed information.
- </para>
- </remarks>
- <seealso cref="M:Fatal(object)"/>
- </member>
- <member name="M:log4net.Core.LogImpl.FatalFormat(System.String,System.Object[])">
- <summary>
- Logs a formatted message string with the <c>FATAL</c> level.
- </summary>
- <param name="format">A String containing zero or more format items</param>
- <param name="args">An Object array containing zero or more objects to format</param>
- <remarks>
- <para>
- The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
- <c>String.Format</c> for details of the syntax of the format string and the behavior
- of the formatting.
- </para>
- <para>
- The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
- format provider. To specify a localized provider use the
- <see cref="M:FatalFormat(IFormatProvider,string,object[])"/> method.
- </para>
- <para>
- This method does not take an <see cref="T:System.Exception"/> object to include in the
- log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Fatal(object)"/>
- methods instead.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Core.LogImpl.FatalFormat(System.String,System.Object)">
- <summary>
- Logs a formatted message string with the <c>FATAL</c> level.
- </summary>
- <param name="format">A String containing zero or more format items</param>
- <param name="arg0">An Object to format</param>
- <remarks>
- <para>
- The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
- <c>String.Format</c> for details of the syntax of the format string and the behavior
- of the formatting.
- </para>
- <para>
- The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
- format provider. To specify a localized provider use the
- <see cref="M:FatalFormat(IFormatProvider,string,object[])"/> method.
- </para>
- <para>
- This method does not take an <see cref="T:System.Exception"/> object to include in the
- log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Fatal(object)"/>
- methods instead.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Core.LogImpl.FatalFormat(System.String,System.Object,System.Object)">
- <summary>
- Logs a formatted message string with the <c>FATAL</c> level.
- </summary>
- <param name="format">A String containing zero or more format items</param>
- <param name="arg0">An Object to format</param>
- <param name="arg1">An Object to format</param>
- <remarks>
- <para>
- The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
- <c>String.Format</c> for details of the syntax of the format string and the behavior
- of the formatting.
- </para>
- <para>
- The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
- format provider. To specify a localized provider use the
- <see cref="M:FatalFormat(IFormatProvider,string,object[])"/> method.
- </para>
- <para>
- This method does not take an <see cref="T:System.Exception"/> object to include in the
- log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Fatal(object)"/>
- methods instead.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Core.LogImpl.FatalFormat(System.String,System.Object,System.Object,System.Object)">
- <summary>
- Logs a formatted message string with the <c>FATAL</c> level.
- </summary>
- <param name="format">A String containing zero or more format items</param>
- <param name="arg0">An Object to format</param>
- <param name="arg1">An Object to format</param>
- <param name="arg2">An Object to format</param>
- <remarks>
- <para>
- The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
- <c>String.Format</c> for details of the syntax of the format string and the behavior
- of the formatting.
- </para>
- <para>
- The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
- format provider. To specify a localized provider use the
- <see cref="M:FatalFormat(IFormatProvider,string,object[])"/> method.
- </para>
- <para>
- This method does not take an <see cref="T:System.Exception"/> object to include in the
- log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Fatal(object)"/>
- methods instead.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Core.LogImpl.FatalFormat(System.IFormatProvider,System.String,System.Object[])">
- <summary>
- Logs a formatted message string with the <c>FATAL</c> level.
- </summary>
- <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param>
- <param name="format">A String containing zero or more format items</param>
- <param name="args">An Object array containing zero or more objects to format</param>
- <remarks>
- <para>
- The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
- <c>String.Format</c> for details of the syntax of the format string and the behavior
- of the formatting.
- </para>
- <para>
- This method does not take an <see cref="T:System.Exception"/> object to include in the
- log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Fatal(object)"/>
- methods instead.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Core.LogImpl.LoggerRepositoryConfigurationChanged(System.Object,System.EventArgs)">
- <summary>
- Event handler for the <see cref="E:log4net.Repository.ILoggerRepository.ConfigurationChanged"/> event
- </summary>
- <param name="sender">the repository</param>
- <param name="e">Empty</param>
- </member>
- <member name="F:log4net.Core.LogImpl.ThisDeclaringType">
- <summary>
- The fully qualified name of this declaring type not the type of any subclass.
- </summary>
- </member>
- <member name="P:log4net.Core.LogImpl.IsDebugEnabled">
- <summary>
- Checks if this logger is enabled for the <c>DEBUG</c>
- level.
- </summary>
- <value>
- <c>true</c> if this logger is enabled for <c>DEBUG</c> events,
- <c>false</c> otherwise.
- </value>
- <remarks>
- <para>
- This function is intended to lessen the computational cost of
- disabled log debug statements.
- </para>
- <para>
- For some <c>log</c> Logger object, when you write:
- </para>
- <code lang="C#">
- log.Debug("This is entry number: " + i );
- </code>
- <para>
- You incur the cost constructing the message, concatenation in
- this case, regardless of whether the message is logged or not.
- </para>
- <para>
- If you are worried about speed, then you should write:
- </para>
- <code lang="C#">
- if (log.IsDebugEnabled())
- {
- log.Debug("This is entry number: " + i );
- }
- </code>
- <para>
- This way you will not incur the cost of parameter
- construction if debugging is disabled for <c>log</c>. On
- the other hand, if the <c>log</c> is debug enabled, you
- will incur the cost of evaluating whether the logger is debug
- enabled twice. Once in <c>IsDebugEnabled</c> and once in
- the <c>Debug</c>. This is an insignificant overhead
- since evaluating a logger takes about 1% of the time it
- takes to actually log.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Core.LogImpl.IsInfoEnabled">
- <summary>
- Checks if this logger is enabled for the <c>INFO</c> level.
- </summary>
- <value>
- <c>true</c> if this logger is enabled for <c>INFO</c> events,
- <c>false</c> otherwise.
- </value>
- <remarks>
- <para>
- See <see cref="P:log4net.Core.LogImpl.IsDebugEnabled"/> for more information and examples
- of using this method.
- </para>
- </remarks>
- <seealso cref="P:log4net.Core.LogImpl.IsDebugEnabled"/>
- </member>
- <member name="P:log4net.Core.LogImpl.IsWarnEnabled">
- <summary>
- Checks if this logger is enabled for the <c>WARN</c> level.
- </summary>
- <value>
- <c>true</c> if this logger is enabled for <c>WARN</c> events,
- <c>false</c> otherwise.
- </value>
- <remarks>
- <para>
- See <see cref="P:log4net.Core.LogImpl.IsDebugEnabled"/> for more information and examples
- of using this method.
- </para>
- </remarks>
- <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
- </member>
- <member name="P:log4net.Core.LogImpl.IsErrorEnabled">
- <summary>
- Checks if this logger is enabled for the <c>ERROR</c> level.
- </summary>
- <value>
- <c>true</c> if this logger is enabled for <c>ERROR</c> events,
- <c>false</c> otherwise.
- </value>
- <remarks>
- <para>
- See <see cref="P:log4net.Core.LogImpl.IsDebugEnabled"/> for more information and examples of using this method.
- </para>
- </remarks>
- <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
- </member>
- <member name="P:log4net.Core.LogImpl.IsFatalEnabled">
- <summary>
- Checks if this logger is enabled for the <c>FATAL</c> level.
- </summary>
- <value>
- <c>true</c> if this logger is enabled for <c>FATAL</c> events,
- <c>false</c> otherwise.
- </value>
- <remarks>
- <para>
- See <see cref="P:log4net.Core.LogImpl.IsDebugEnabled"/> for more information and examples of using this method.
- </para>
- </remarks>
- <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
- </member>
- <member name="T:log4net.Core.MethodItem">
- <summary>
- provides method information without actually referencing a System.Reflection.MethodBase
- as that would require that the containing assembly is loaded.
- </summary>
-
- </member>
- <member name="F:log4net.Core.MethodItem.NA">
- <summary>
- When location information is not available the constant
- <c>NA</c> is returned. Current value of this string
- constant is <b>?</b>.
- </summary>
- </member>
- <member name="M:log4net.Core.MethodItem.#ctor">
- <summary>
- constructs a method item for an unknown method.
- </summary>
- </member>
- <member name="M:log4net.Core.MethodItem.#ctor(System.String)">
- <summary>
- constructs a method item from the name of the method.
- </summary>
- <param name="name"></param>
- </member>
- <member name="M:log4net.Core.MethodItem.#ctor(System.String,System.String[])">
- <summary>
- constructs a method item from the name of the method and its parameters.
- </summary>
- <param name="name"></param>
- <param name="parameters"></param>
- </member>
- <member name="M:log4net.Core.MethodItem.#ctor(System.Reflection.MethodBase)">
- <summary>
- constructs a method item from a method base by determining the method name and its parameters.
- </summary>
- <param name="methodBase"></param>
- </member>
- <member name="F:log4net.Core.MethodItem.declaringType">
- <summary>
- The fully qualified type of the StackFrameItem class.
- </summary>
- <remarks>
- Used by the internal logger to record the Type of the
- log message.
- </remarks>
- </member>
- <member name="P:log4net.Core.MethodItem.Name">
- <summary>
- Gets the method name of the caller making the logging
- request.
- </summary>
- <value>
- The method name of the caller making the logging
- request.
- </value>
- <remarks>
- <para>
- Gets the method name of the caller making the logging
- request.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Core.MethodItem.Parameters">
- <summary>
- Gets the method parameters of the caller making
- the logging request.
- </summary>
- <value>
- The method parameters of the caller making
- the logging request
- </value>
- <remarks>
- <para>
- Gets the method parameters of the caller making
- the logging request.
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Core.SecurityContext">
- <summary>
- A SecurityContext used by log4net when interacting with protected resources
- </summary>
- <remarks>
- <para>
- A SecurityContext used by log4net when interacting with protected resources
- for example with operating system services. This can be used to impersonate
- a principal that has been granted privileges on the system resources.
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- </member>
- <member name="M:log4net.Core.SecurityContext.Impersonate(System.Object)">
- <summary>
- Impersonate this SecurityContext
- </summary>
- <param name="state">State supplied by the caller</param>
- <returns>An <see cref="T:System.IDisposable"/> instance that will
- revoke the impersonation of this SecurityContext, or <c>null</c></returns>
- <remarks>
- <para>
- Impersonate this security context. Further calls on the current
- thread should now be made in the security context provided
- by this object. When the <see cref="T:System.IDisposable"/> result
- <see cref="M:System.IDisposable.Dispose"/> method is called the security
- context of the thread should be reverted to the state it was in
- before <see cref="M:log4net.Core.SecurityContext.Impersonate(System.Object)"/> was called.
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Core.SecurityContextProvider">
- <summary>
- The <see cref="T:log4net.Core.SecurityContextProvider"/> providers default <see cref="T:log4net.Core.SecurityContext"/> instances.
- </summary>
- <remarks>
- <para>
- A configured component that interacts with potentially protected system
- resources uses a <see cref="T:log4net.Core.SecurityContext"/> to provide the elevated
- privileges required. If the <see cref="T:log4net.Core.SecurityContext"/> object has
- been not been explicitly provided to the component then the component
- will request one from this <see cref="T:log4net.Core.SecurityContextProvider"/>.
- </para>
- <para>
- By default the <see cref="P:log4net.Core.SecurityContextProvider.DefaultProvider"/> is
- an instance of <see cref="T:log4net.Core.SecurityContextProvider"/> which returns only
- <see cref="T:log4net.Util.NullSecurityContext"/> objects. This is a reasonable default
- where the privileges required are not know by the system.
- </para>
- <para>
- This default behavior can be overridden by subclassing the <see cref="T:log4net.Core.SecurityContextProvider"/>
- and overriding the <see cref="M:log4net.Core.SecurityContextProvider.CreateSecurityContext(System.Object)"/> method to return
- the desired <see cref="T:log4net.Core.SecurityContext"/> objects. The default provider
- can be replaced by programmatically setting the value of the
- <see cref="P:log4net.Core.SecurityContextProvider.DefaultProvider"/> property.
- </para>
- <para>
- An alternative is to use the <c>log4net.Config.SecurityContextProviderAttribute</c>
- This attribute can be applied to an assembly in the same way as the
- <c>log4net.Config.XmlConfiguratorAttribute"</c>. The attribute takes
- the type to use as the <see cref="T:log4net.Core.SecurityContextProvider"/> as an argument.
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- </member>
- <member name="F:log4net.Core.SecurityContextProvider.s_defaultProvider">
- <summary>
- The default provider
- </summary>
- </member>
- <member name="M:log4net.Core.SecurityContextProvider.#ctor">
- <summary>
- Protected default constructor to allow subclassing
- </summary>
- <remarks>
- <para>
- Protected default constructor to allow subclassing
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Core.SecurityContextProvider.CreateSecurityContext(System.Object)">
- <summary>
- Create a SecurityContext for a consumer
- </summary>
- <param name="consumer">The consumer requesting the SecurityContext</param>
- <returns>An impersonation context</returns>
- <remarks>
- <para>
- The default implementation is to return a <see cref="T:log4net.Util.NullSecurityContext"/>.
- </para>
- <para>
- Subclasses should override this method to provide their own
- behavior.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Core.SecurityContextProvider.DefaultProvider">
- <summary>
- Gets or sets the default SecurityContextProvider
- </summary>
- <value>
- The default SecurityContextProvider
- </value>
- <remarks>
- <para>
- The default provider is used by configured components that
- require a <see cref="T:log4net.Core.SecurityContext"/> and have not had one
- given to them.
- </para>
- <para>
- By default this is an instance of <see cref="T:log4net.Core.SecurityContextProvider"/>
- that returns <see cref="T:log4net.Util.NullSecurityContext"/> objects.
- </para>
- <para>
- The default provider can be set programmatically by setting
- the value of this property to a sub class of <see cref="T:log4net.Core.SecurityContextProvider"/>
- that has the desired behavior.
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Core.StackFrameItem">
- <summary>
- provides stack frame information without actually referencing a System.Diagnostics.StackFrame
- as that would require that the containing assembly is loaded.
- </summary>
-
- </member>
- <member name="F:log4net.Core.StackFrameItem.NA">
- <summary>
- When location information is not available the constant
- <c>NA</c> is returned. Current value of this string
- constant is <b>?</b>.
- </summary>
- </member>
- <member name="M:log4net.Core.StackFrameItem.#ctor(System.Diagnostics.StackFrame)">
- <summary>
- returns a stack frame item from a stack frame. This
- </summary>
- <param name="frame"></param>
- <returns></returns>
- </member>
- <member name="F:log4net.Core.StackFrameItem.declaringType">
- <summary>
- The fully qualified type of the StackFrameItem class.
- </summary>
- <remarks>
- Used by the internal logger to record the Type of the
- log message.
- </remarks>
- </member>
- <member name="P:log4net.Core.StackFrameItem.ClassName">
- <summary>
- Gets the fully qualified class name of the caller making the logging
- request.
- </summary>
- <value>
- The fully qualified class name of the caller making the logging
- request.
- </value>
- <remarks>
- <para>
- Gets the fully qualified class name of the caller making the logging
- request.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Core.StackFrameItem.FileName">
- <summary>
- Gets the file name of the caller.
- </summary>
- <value>
- The file name of the caller.
- </value>
- <remarks>
- <para>
- Gets the file name of the caller.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Core.StackFrameItem.LineNumber">
- <summary>
- Gets the line number of the caller.
- </summary>
- <value>
- The line number of the caller.
- </value>
- <remarks>
- <para>
- Gets the line number of the caller.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Core.StackFrameItem.Method">
- <summary>
- Gets the method name of the caller.
- </summary>
- <value>
- The method name of the caller.
- </value>
- <remarks>
- <para>
- Gets the method name of the caller.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Core.StackFrameItem.FullInfo">
- <summary>
- Gets all available caller information
- </summary>
- <value>
- All available caller information, in the format
- <c>fully.qualified.classname.of.caller.methodName(Filename:line)</c>
- </value>
- <remarks>
- <para>
- Gets all available caller information, in the format
- <c>fully.qualified.classname.of.caller.methodName(Filename:line)</c>
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Core.TimeEvaluator">
- <summary>
- An evaluator that triggers after specified number of seconds.
- </summary>
- <remarks>
- <para>
- This evaluator will trigger if the specified time period
- <see cref="P:log4net.Core.TimeEvaluator.Interval"/> has passed since last check.
- </para>
- </remarks>
- <author>Robert Sevcik</author>
- </member>
- <member name="F:log4net.Core.TimeEvaluator.DEFAULT_INTERVAL">
- <summary>
- The default time threshold for triggering in seconds. Zero means it won't trigger at all.
- </summary>
- </member>
- <member name="F:log4net.Core.TimeEvaluator.m_interval">
- <summary>
- The time threshold for triggering in seconds. Zero means it won't trigger at all.
- </summary>
- </member>
- <member name="F:log4net.Core.TimeEvaluator.m_lasttime">
- <summary>
- The time of last check. This gets updated when the object is created and when the evaluator triggers.
- </summary>
- </member>
- <member name="M:log4net.Core.TimeEvaluator.#ctor">
- <summary>
- Create a new evaluator using the <see cref="F:log4net.Core.TimeEvaluator.DEFAULT_INTERVAL"/> time threshold in seconds.
- </summary>
- <remarks>
- <para>
- Create a new evaluator using the <see cref="F:log4net.Core.TimeEvaluator.DEFAULT_INTERVAL"/> time threshold in seconds.
- </para>
- <para>
- This evaluator will trigger if the specified time period
- <see cref="P:log4net.Core.TimeEvaluator.Interval"/> has passed since last check.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Core.TimeEvaluator.#ctor(System.Int32)">
- <summary>
- Create a new evaluator using the specified time threshold in seconds.
- </summary>
- <param name="interval">
- The time threshold in seconds to trigger after.
- Zero means it won't trigger at all.
- </param>
- <remarks>
- <para>
- Create a new evaluator using the specified time threshold in seconds.
- </para>
- <para>
- This evaluator will trigger if the specified time period
- <see cref="P:log4net.Core.TimeEvaluator.Interval"/> has passed since last check.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Core.TimeEvaluator.IsTriggeringEvent(log4net.Core.LoggingEvent)">
- <summary>
- Is this <paramref name="loggingEvent"/> the triggering event?
- </summary>
- <param name="loggingEvent">The event to check</param>
- <returns>This method returns <c>true</c>, if the specified time period
- <see cref="P:log4net.Core.TimeEvaluator.Interval"/> has passed since last check..
- Otherwise it returns <c>false</c></returns>
- <remarks>
- <para>
- This evaluator will trigger if the specified time period
- <see cref="P:log4net.Core.TimeEvaluator.Interval"/> has passed since last check.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Core.TimeEvaluator.Interval">
- <summary>
- The time threshold in seconds to trigger after
- </summary>
- <value>
- The time threshold in seconds to trigger after.
- Zero means it won't trigger at all.
- </value>
- <remarks>
- <para>
- This evaluator will trigger if the specified time period
- <see cref="P:log4net.Core.TimeEvaluator.Interval"/> has passed since last check.
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Core.WrapperCreationHandler">
- <summary>
- Delegate used to handle creation of new wrappers.
- </summary>
- <param name="logger">The logger to wrap in a wrapper.</param>
- <remarks>
- <para>
- Delegate used to handle creation of new wrappers. This delegate
- is called from the <see cref="M:log4net.Core.WrapperMap.CreateNewWrapperObject(log4net.Core.ILogger)"/>
- method to construct the wrapper for the specified logger.
- </para>
- <para>
- The delegate to use is supplied to the <see cref="T:log4net.Core.WrapperMap"/>
- constructor.
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Core.WrapperMap">
- <summary>
- Maps between logger objects and wrapper objects.
- </summary>
- <remarks>
- <para>
- This class maintains a mapping between <see cref="T:log4net.Core.ILogger"/> objects and
- <see cref="T:log4net.Core.ILoggerWrapper"/> objects. Use the <see cref="M:log4net.Core.WrapperMap.GetWrapper(log4net.Core.ILogger)"/> method to
- lookup the <see cref="T:log4net.Core.ILoggerWrapper"/> for the specified <see cref="T:log4net.Core.ILogger"/>.
- </para>
- <para>
- New wrapper instances are created by the <see cref="M:log4net.Core.WrapperMap.CreateNewWrapperObject(log4net.Core.ILogger)"/>
- method. The default behavior is for this method to delegate construction
- of the wrapper to the <see cref="T:log4net.Core.WrapperCreationHandler"/> delegate supplied
- to the constructor. This allows specialization of the behavior without
- requiring subclassing of this type.
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- <author>Gert Driesen</author>
- </member>
- <member name="M:log4net.Core.WrapperMap.#ctor(log4net.Core.WrapperCreationHandler)">
- <summary>
- Initializes a new instance of the <see cref="T:log4net.Core.WrapperMap"/>
- </summary>
- <param name="createWrapperHandler">The handler to use to create the wrapper objects.</param>
- <remarks>
- <para>
- Initializes a new instance of the <see cref="T:log4net.Core.WrapperMap"/> class with
- the specified handler to create the wrapper objects.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Core.WrapperMap.GetWrapper(log4net.Core.ILogger)">
- <summary>
- Gets the wrapper object for the specified logger.
- </summary>
- <returns>The wrapper object for the specified logger</returns>
- <remarks>
- <para>
- If the logger is null then the corresponding wrapper is null.
- </para>
- <para>
- Looks up the wrapper it it has previously been requested and
- returns it. If the wrapper has never been requested before then
- the <see cref="M:log4net.Core.WrapperMap.CreateNewWrapperObject(log4net.Core.ILogger)"/> virtual method is
- called.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Core.WrapperMap.CreateNewWrapperObject(log4net.Core.ILogger)">
- <summary>
- Creates the wrapper object for the specified logger.
- </summary>
- <param name="logger">The logger to wrap in a wrapper.</param>
- <returns>The wrapper object for the logger.</returns>
- <remarks>
- <para>
- This implementation uses the <see cref="T:log4net.Core.WrapperCreationHandler"/>
- passed to the constructor to create the wrapper. This method
- can be overridden in a subclass.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Core.WrapperMap.RepositoryShutdown(log4net.Repository.ILoggerRepository)">
- <summary>
- Called when a monitored repository shutdown event is received.
- </summary>
- <param name="repository">The <see cref="T:log4net.Repository.ILoggerRepository"/> that is shutting down</param>
- <remarks>
- <para>
- This method is called when a <see cref="T:log4net.Repository.ILoggerRepository"/> that this
- <see cref="T:log4net.Core.WrapperMap"/> is holding loggers for has signaled its shutdown
- event <see cref="E:log4net.Repository.ILoggerRepository.ShutdownEvent"/>. The default
- behavior of this method is to release the references to the loggers
- and their wrappers generated for this repository.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Core.WrapperMap.ILoggerRepository_Shutdown(System.Object,System.EventArgs)">
- <summary>
- Event handler for repository shutdown event.
- </summary>
- <param name="sender">The sender of the event.</param>
- <param name="e">The event args.</param>
- </member>
- <member name="F:log4net.Core.WrapperMap.m_repositories">
- <summary>
- Map of logger repositories to hashtables of ILogger to ILoggerWrapper mappings
- </summary>
- </member>
- <member name="F:log4net.Core.WrapperMap.m_createWrapperHandler">
- <summary>
- The handler to use to create the extension wrapper objects.
- </summary>
- </member>
- <member name="F:log4net.Core.WrapperMap.m_shutdownHandler">
- <summary>
- Internal reference to the delegate used to register for repository shutdown events.
- </summary>
- </member>
- <member name="P:log4net.Core.WrapperMap.Repositories">
- <summary>
- Gets the map of logger repositories.
- </summary>
- <value>
- Map of logger repositories.
- </value>
- <remarks>
- <para>
- Gets the hashtable that is keyed on <see cref="T:log4net.Repository.ILoggerRepository"/>. The
- values are hashtables keyed on <see cref="T:log4net.Core.ILogger"/> with the
- value being the corresponding <see cref="T:log4net.Core.ILoggerWrapper"/>.
- </para>
- </remarks>
- </member>
- <member name="T:log4net.DateFormatter.AbsoluteTimeDateFormatter">
- <summary>
- Formats a <see cref="T:System.DateTime"/> as <c>"HH:mm:ss,fff"</c>.
- </summary>
- <remarks>
- <para>
- Formats a <see cref="T:System.DateTime"/> in the format <c>"HH:mm:ss,fff"</c> for example, <c>"15:49:37,459"</c>.
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- <author>Gert Driesen</author>
- </member>
- <member name="T:log4net.DateFormatter.IDateFormatter">
- <summary>
- Render a <see cref="T:System.DateTime"/> as a string.
- </summary>
- <remarks>
- <para>
- Interface to abstract the rendering of a <see cref="T:System.DateTime"/>
- instance into a string.
- </para>
- <para>
- The <see cref="M:log4net.DateFormatter.IDateFormatter.FormatDate(System.DateTime,System.IO.TextWriter)"/> method is used to render the
- date to a text writer.
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- <author>Gert Driesen</author>
- </member>
- <member name="M:log4net.DateFormatter.IDateFormatter.FormatDate(System.DateTime,System.IO.TextWriter)">
- <summary>
- Formats the specified date as a string.
- </summary>
- <param name="dateToFormat">The date to format.</param>
- <param name="writer">The writer to write to.</param>
- <remarks>
- <para>
- Format the <see cref="T:System.DateTime"/> as a string and write it
- to the <see cref="T:System.IO.TextWriter"/> provided.
- </para>
- </remarks>
- </member>
- <member name="F:log4net.DateFormatter.AbsoluteTimeDateFormatter.AbsoluteTimeDateFormat">
- <summary>
- String constant used to specify AbsoluteTimeDateFormat in layouts. Current value is <b>ABSOLUTE</b>.
- </summary>
- </member>
- <member name="F:log4net.DateFormatter.AbsoluteTimeDateFormatter.DateAndTimeDateFormat">
- <summary>
- String constant used to specify DateTimeDateFormat in layouts. Current value is <b>DATE</b>.
- </summary>
- </member>
- <member name="F:log4net.DateFormatter.AbsoluteTimeDateFormatter.Iso8601TimeDateFormat">
- <summary>
- String constant used to specify ISO8601DateFormat in layouts. Current value is <b>ISO8601</b>.
- </summary>
- </member>
- <member name="M:log4net.DateFormatter.AbsoluteTimeDateFormatter.FormatDateWithoutMillis(System.DateTime,System.Text.StringBuilder)">
- <summary>
- Renders the date into a string. Format is <c>"HH:mm:ss"</c>.
- </summary>
- <param name="dateToFormat">The date to render into a string.</param>
- <param name="buffer">The string builder to write to.</param>
- <remarks>
- <para>
- Subclasses should override this method to render the date
- into a string using a precision up to the second. This method
- will be called at most once per second and the result will be
- reused if it is needed again during the same second.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.DateFormatter.AbsoluteTimeDateFormatter.FormatDate(System.DateTime,System.IO.TextWriter)">
- <summary>
- Renders the date into a string. Format is "HH:mm:ss,fff".
- </summary>
- <param name="dateToFormat">The date to render into a string.</param>
- <param name="writer">The writer to write to.</param>
- <remarks>
- <para>
- Uses the <see cref="M:log4net.DateFormatter.AbsoluteTimeDateFormatter.FormatDateWithoutMillis(System.DateTime,System.Text.StringBuilder)"/> method to generate the
- time string up to the seconds and then appends the current
- milliseconds. The results from <see cref="M:log4net.DateFormatter.AbsoluteTimeDateFormatter.FormatDateWithoutMillis(System.DateTime,System.Text.StringBuilder)"/> are
- cached and <see cref="M:log4net.DateFormatter.AbsoluteTimeDateFormatter.FormatDateWithoutMillis(System.DateTime,System.Text.StringBuilder)"/> is called at most once
- per second.
- </para>
- <para>
- Sub classes should override <see cref="M:log4net.DateFormatter.AbsoluteTimeDateFormatter.FormatDateWithoutMillis(System.DateTime,System.Text.StringBuilder)"/>
- rather than <see cref="M:log4net.DateFormatter.AbsoluteTimeDateFormatter.FormatDate(System.DateTime,System.IO.TextWriter)"/>.
- </para>
- </remarks>
- </member>
- <member name="F:log4net.DateFormatter.AbsoluteTimeDateFormatter.s_lastTimeToTheSecond">
- <summary>
- Last stored time with precision up to the second.
- </summary>
- </member>
- <member name="F:log4net.DateFormatter.AbsoluteTimeDateFormatter.s_lastTimeBuf">
- <summary>
- Last stored time with precision up to the second, formatted
- as a string.
- </summary>
- </member>
- <member name="F:log4net.DateFormatter.AbsoluteTimeDateFormatter.s_lastTimeStrings">
- <summary>
- Last stored time with precision up to the second, formatted
- as a string.
- </summary>
- </member>
- <member name="T:log4net.DateFormatter.DateTimeDateFormatter">
- <summary>
- Formats a <see cref="T:System.DateTime"/> as <c>"dd MMM yyyy HH:mm:ss,fff"</c>
- </summary>
- <remarks>
- <para>
- Formats a <see cref="T:System.DateTime"/> in the format
- <c>"dd MMM yyyy HH:mm:ss,fff"</c> for example,
- <c>"06 Nov 1994 15:49:37,459"</c>.
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- <author>Gert Driesen</author>
- <author>Angelika Schnagl</author>
- </member>
- <member name="M:log4net.DateFormatter.DateTimeDateFormatter.#ctor">
- <summary>
- Default constructor.
- </summary>
- <remarks>
- <para>
- Initializes a new instance of the <see cref="T:log4net.DateFormatter.DateTimeDateFormatter"/> class.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.DateFormatter.DateTimeDateFormatter.FormatDateWithoutMillis(System.DateTime,System.Text.StringBuilder)">
- <summary>
- Formats the date without the milliseconds part
- </summary>
- <param name="dateToFormat">The date to format.</param>
- <param name="buffer">The string builder to write to.</param>
- <remarks>
- <para>
- Formats a DateTime in the format <c>"dd MMM yyyy HH:mm:ss"</c>
- for example, <c>"06 Nov 1994 15:49:37"</c>.
- </para>
- <para>
- The base class will append the <c>",fff"</c> milliseconds section.
- This method will only be called at most once per second.
- </para>
- </remarks>
- </member>
- <member name="F:log4net.DateFormatter.DateTimeDateFormatter.m_dateTimeFormatInfo">
- <summary>
- The format info for the invariant culture.
- </summary>
- </member>
- <member name="T:log4net.DateFormatter.Iso8601DateFormatter">
- <summary>
- Formats the <see cref="T:System.DateTime"/> as <c>"yyyy-MM-dd HH:mm:ss,fff"</c>.
- </summary>
- <remarks>
- <para>
- Formats the <see cref="T:System.DateTime"/> specified as a string: <c>"yyyy-MM-dd HH:mm:ss,fff"</c>.
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- <author>Gert Driesen</author>
- </member>
- <member name="M:log4net.DateFormatter.Iso8601DateFormatter.#ctor">
- <summary>
- Default constructor
- </summary>
- <remarks>
- <para>
- Initializes a new instance of the <see cref="T:log4net.DateFormatter.Iso8601DateFormatter"/> class.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.DateFormatter.Iso8601DateFormatter.FormatDateWithoutMillis(System.DateTime,System.Text.StringBuilder)">
- <summary>
- Formats the date without the milliseconds part
- </summary>
- <param name="dateToFormat">The date to format.</param>
- <param name="buffer">The string builder to write to.</param>
- <remarks>
- <para>
- Formats the date specified as a string: <c>"yyyy-MM-dd HH:mm:ss"</c>.
- </para>
- <para>
- The base class will append the <c>",fff"</c> milliseconds section.
- This method will only be called at most once per second.
- </para>
- </remarks>
- </member>
- <member name="T:log4net.DateFormatter.SimpleDateFormatter">
- <summary>
- Formats the <see cref="T:System.DateTime"/> using the <see cref="M:DateTime.ToString(string, IFormatProvider)"/> method.
- </summary>
- <remarks>
- <para>
- Formats the <see cref="T:System.DateTime"/> using the <see cref="T:System.DateTime"/> <see cref="M:DateTime.ToString(string, IFormatProvider)"/> method.
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- <author>Gert Driesen</author>
- </member>
- <member name="M:log4net.DateFormatter.SimpleDateFormatter.#ctor(System.String)">
- <summary>
- Constructor
- </summary>
- <param name="format">The format string.</param>
- <remarks>
- <para>
- Initializes a new instance of the <see cref="T:log4net.DateFormatter.SimpleDateFormatter"/> class
- with the specified format string.
- </para>
- <para>
- The format string must be compatible with the options
- that can be supplied to <see cref="M:DateTime.ToString(string, IFormatProvider)"/>.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.DateFormatter.SimpleDateFormatter.FormatDate(System.DateTime,System.IO.TextWriter)">
- <summary>
- Formats the date using <see cref="M:DateTime.ToString(string, IFormatProvider)"/>.
- </summary>
- <param name="dateToFormat">The date to convert to a string.</param>
- <param name="writer">The writer to write to.</param>
- <remarks>
- <para>
- Uses the date format string supplied to the constructor to call
- the <see cref="M:DateTime.ToString(string, IFormatProvider)"/> method to format the date.
- </para>
- </remarks>
- </member>
- <member name="F:log4net.DateFormatter.SimpleDateFormatter.m_formatString">
- <summary>
- The format string used to format the <see cref="T:System.DateTime"/>.
- </summary>
- <remarks>
- <para>
- The format string must be compatible with the options
- that can be supplied to <see cref="M:DateTime.ToString(string, IFormatProvider)"/>.
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Filter.DenyAllFilter">
- <summary>
- This filter drops all <see cref="T:log4net.Core.LoggingEvent"/>.
- </summary>
- <remarks>
- <para>
- You can add this filter to the end of a filter chain to
- switch from the default "accept all unless instructed otherwise"
- filtering behavior to a "deny all unless instructed otherwise"
- behavior.
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- <author>Gert Driesen</author>
- </member>
- <member name="T:log4net.Filter.FilterSkeleton">
- <summary>
- Subclass this type to implement customized logging event filtering
- </summary>
- <remarks>
- <para>
- Users should extend this class to implement customized logging
- event filtering. Note that <see cref="T:log4net.Repository.Hierarchy.Logger"/> and
- <see cref="T:log4net.Appender.AppenderSkeleton"/>, the parent class of all standard
- appenders, have built-in filtering rules. It is suggested that you
- first use and understand the built-in rules before rushing to write
- your own custom filters.
- </para>
- <para>
- This abstract class assumes and also imposes that filters be
- organized in a linear chain. The <see cref="M:log4net.Filter.FilterSkeleton.Decide(log4net.Core.LoggingEvent)"/>
- method of each filter is called sequentially, in the order of their
- addition to the chain.
- </para>
- <para>
- The <see cref="M:log4net.Filter.FilterSkeleton.Decide(log4net.Core.LoggingEvent)"/> method must return one
- of the integer constants <see cref="F:log4net.Filter.FilterDecision.Deny"/>,
- <see cref="F:log4net.Filter.FilterDecision.Neutral"/> or <see cref="F:log4net.Filter.FilterDecision.Accept"/>.
- </para>
- <para>
- If the value <see cref="F:log4net.Filter.FilterDecision.Deny"/> is returned, then the log event is dropped
- immediately without consulting with the remaining filters.
- </para>
- <para>
- If the value <see cref="F:log4net.Filter.FilterDecision.Neutral"/> is returned, then the next filter
- in the chain is consulted. If there are no more filters in the
- chain, then the log event is logged. Thus, in the presence of no
- filters, the default behavior is to log all logging events.
- </para>
- <para>
- If the value <see cref="F:log4net.Filter.FilterDecision.Accept"/> is returned, then the log
- event is logged without consulting the remaining filters.
- </para>
- <para>
- The philosophy of log4net filters is largely inspired from the
- Linux ipchains.
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- <author>Gert Driesen</author>
- </member>
- <member name="T:log4net.Filter.IFilter">
- <summary>
- Implement this interface to provide customized logging event filtering
- </summary>
- <remarks>
- <para>
- Users should implement this interface to implement customized logging
- event filtering. Note that <see cref="T:log4net.Repository.Hierarchy.Logger"/> and
- <see cref="T:log4net.Appender.AppenderSkeleton"/>, the parent class of all standard
- appenders, have built-in filtering rules. It is suggested that you
- first use and understand the built-in rules before rushing to write
- your own custom filters.
- </para>
- <para>
- This abstract class assumes and also imposes that filters be
- organized in a linear chain. The <see cref="M:log4net.Filter.IFilter.Decide(log4net.Core.LoggingEvent)"/>
- method of each filter is called sequentially, in the order of their
- addition to the chain.
- </para>
- <para>
- The <see cref="M:log4net.Filter.IFilter.Decide(log4net.Core.LoggingEvent)"/> method must return one
- of the integer constants <see cref="F:log4net.Filter.FilterDecision.Deny"/>,
- <see cref="F:log4net.Filter.FilterDecision.Neutral"/> or <see cref="F:log4net.Filter.FilterDecision.Accept"/>.
- </para>
- <para>
- If the value <see cref="F:log4net.Filter.FilterDecision.Deny"/> is returned, then the log event is dropped
- immediately without consulting with the remaining filters.
- </para>
- <para>
- If the value <see cref="F:log4net.Filter.FilterDecision.Neutral"/> is returned, then the next filter
- in the chain is consulted. If there are no more filters in the
- chain, then the log event is logged. Thus, in the presence of no
- filters, the default behavior is to log all logging events.
- </para>
- <para>
- If the value <see cref="F:log4net.Filter.FilterDecision.Accept"/> is returned, then the log
- event is logged without consulting the remaining filters.
- </para>
- <para>
- The philosophy of log4net filters is largely inspired from the
- Linux ipchains.
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- <author>Gert Driesen</author>
- </member>
- <member name="M:log4net.Filter.IFilter.Decide(log4net.Core.LoggingEvent)">
- <summary>
- Decide if the logging event should be logged through an appender.
- </summary>
- <param name="loggingEvent">The LoggingEvent to decide upon</param>
- <returns>The decision of the filter</returns>
- <remarks>
- <para>
- If the decision is <see cref="F:log4net.Filter.FilterDecision.Deny"/>, then the event will be
- dropped. If the decision is <see cref="F:log4net.Filter.FilterDecision.Neutral"/>, then the next
- filter, if any, will be invoked. If the decision is <see cref="F:log4net.Filter.FilterDecision.Accept"/> then
- the event will be logged without consulting with other filters in
- the chain.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Filter.IFilter.Next">
- <summary>
- Property to get and set the next filter
- </summary>
- <value>
- The next filter in the chain
- </value>
- <remarks>
- <para>
- Filters are typically composed into chains. This property allows the next filter in
- the chain to be accessed.
- </para>
- </remarks>
- </member>
- <member name="F:log4net.Filter.FilterSkeleton.m_next">
- <summary>
- Points to the next filter in the filter chain.
- </summary>
- <remarks>
- <para>
- See <see cref="P:log4net.Filter.FilterSkeleton.Next"/> for more information.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Filter.FilterSkeleton.ActivateOptions">
- <summary>
- Initialize the filter with the options set
- </summary>
- <remarks>
- <para>
- This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
- activation scheme. The <see cref="M:log4net.Filter.FilterSkeleton.ActivateOptions"/> method must
- be called on this object after the configuration properties have
- been set. Until <see cref="M:log4net.Filter.FilterSkeleton.ActivateOptions"/> is called this
- object is in an undefined state and must not be used.
- </para>
- <para>
- If any of the configuration properties are modified then
- <see cref="M:log4net.Filter.FilterSkeleton.ActivateOptions"/> must be called again.
- </para>
- <para>
- Typically filter's options become active immediately on set,
- however this method must still be called.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Filter.FilterSkeleton.Decide(log4net.Core.LoggingEvent)">
- <summary>
- Decide if the <see cref="T:log4net.Core.LoggingEvent"/> should be logged through an appender.
- </summary>
- <param name="loggingEvent">The <see cref="T:log4net.Core.LoggingEvent"/> to decide upon</param>
- <returns>The decision of the filter</returns>
- <remarks>
- <para>
- If the decision is <see cref="F:log4net.Filter.FilterDecision.Deny"/>, then the event will be
- dropped. If the decision is <see cref="F:log4net.Filter.FilterDecision.Neutral"/>, then the next
- filter, if any, will be invoked. If the decision is <see cref="F:log4net.Filter.FilterDecision.Accept"/> then
- the event will be logged without consulting with other filters in
- the chain.
- </para>
- <para>
- This method is marked <c>abstract</c> and must be implemented
- in a subclass.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Filter.FilterSkeleton.Next">
- <summary>
- Property to get and set the next filter
- </summary>
- <value>
- The next filter in the chain
- </value>
- <remarks>
- <para>
- Filters are typically composed into chains. This property allows the next filter in
- the chain to be accessed.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Filter.DenyAllFilter.#ctor">
- <summary>
- Default constructor
- </summary>
- </member>
- <member name="M:log4net.Filter.DenyAllFilter.Decide(log4net.Core.LoggingEvent)">
- <summary>
- Always returns the integer constant <see cref="F:log4net.Filter.FilterDecision.Deny"/>
- </summary>
- <param name="loggingEvent">the LoggingEvent to filter</param>
- <returns>Always returns <see cref="F:log4net.Filter.FilterDecision.Deny"/></returns>
- <remarks>
- <para>
- Ignores the event being logged and just returns
- <see cref="F:log4net.Filter.FilterDecision.Deny"/>. This can be used to change the default filter
- chain behavior from <see cref="F:log4net.Filter.FilterDecision.Accept"/> to <see cref="F:log4net.Filter.FilterDecision.Deny"/>. This filter
- should only be used as the last filter in the chain
- as any further filters will be ignored!
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Filter.FilterDecision">
- <summary>
- The return result from <see cref="M:log4net.Filter.IFilter.Decide(log4net.Core.LoggingEvent)"/>
- </summary>
- <remarks>
- <para>
- The return result from <see cref="M:log4net.Filter.IFilter.Decide(log4net.Core.LoggingEvent)"/>
- </para>
- </remarks>
- </member>
- <member name="F:log4net.Filter.FilterDecision.Deny">
- <summary>
- The log event must be dropped immediately without
- consulting with the remaining filters, if any, in the chain.
- </summary>
- </member>
- <member name="F:log4net.Filter.FilterDecision.Neutral">
- <summary>
- This filter is neutral with respect to the log event.
- The remaining filters, if any, should be consulted for a final decision.
- </summary>
- </member>
- <member name="F:log4net.Filter.FilterDecision.Accept">
- <summary>
- The log event must be logged immediately without
- consulting with the remaining filters, if any, in the chain.
- </summary>
- </member>
- <member name="T:log4net.Filter.LevelMatchFilter">
- <summary>
- This is a very simple filter based on <see cref="T:log4net.Core.Level"/> matching.
- </summary>
- <remarks>
- <para>
- The filter admits two options <see cref="P:log4net.Filter.LevelMatchFilter.LevelToMatch"/> and
- <see cref="P:log4net.Filter.LevelMatchFilter.AcceptOnMatch"/>. If there is an exact match between the value
- of the <see cref="P:log4net.Filter.LevelMatchFilter.LevelToMatch"/> option and the <see cref="T:log4net.Core.Level"/> of the
- <see cref="T:log4net.Core.LoggingEvent"/>, then the <see cref="M:log4net.Filter.LevelMatchFilter.Decide(log4net.Core.LoggingEvent)"/> method returns <see cref="F:log4net.Filter.FilterDecision.Accept"/> in
- case the <see cref="P:log4net.Filter.LevelMatchFilter.AcceptOnMatch"/> option value is set
- to <c>true</c>, if it is <c>false</c> then
- <see cref="F:log4net.Filter.FilterDecision.Deny"/> is returned. If the <see cref="T:log4net.Core.Level"/> does not match then
- the result will be <see cref="F:log4net.Filter.FilterDecision.Neutral"/>.
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- <author>Gert Driesen</author>
- </member>
- <member name="F:log4net.Filter.LevelMatchFilter.m_acceptOnMatch">
- <summary>
- flag to indicate if the filter should <see cref="F:log4net.Filter.FilterDecision.Accept"/> on a match
- </summary>
- </member>
- <member name="F:log4net.Filter.LevelMatchFilter.m_levelToMatch">
- <summary>
- the <see cref="T:log4net.Core.Level"/> to match against
- </summary>
- </member>
- <member name="M:log4net.Filter.LevelMatchFilter.#ctor">
- <summary>
- Default constructor
- </summary>
- </member>
- <member name="M:log4net.Filter.LevelMatchFilter.Decide(log4net.Core.LoggingEvent)">
- <summary>
- Tests if the <see cref="T:log4net.Core.Level"/> of the logging event matches that of the filter
- </summary>
- <param name="loggingEvent">the event to filter</param>
- <returns>see remarks</returns>
- <remarks>
- <para>
- If the <see cref="T:log4net.Core.Level"/> of the event matches the level of the
- filter then the result of the function depends on the
- value of <see cref="P:log4net.Filter.LevelMatchFilter.AcceptOnMatch"/>. If it is true then
- the function will return <see cref="F:log4net.Filter.FilterDecision.Accept"/>, it it is false then it
- will return <see cref="F:log4net.Filter.FilterDecision.Deny"/>. If the <see cref="T:log4net.Core.Level"/> does not match then
- the result will be <see cref="F:log4net.Filter.FilterDecision.Neutral"/>.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Filter.LevelMatchFilter.AcceptOnMatch">
- <summary>
- <see cref="F:log4net.Filter.FilterDecision.Accept"/> when matching <see cref="P:log4net.Filter.LevelMatchFilter.LevelToMatch"/>
- </summary>
- <remarks>
- <para>
- The <see cref="P:log4net.Filter.LevelMatchFilter.AcceptOnMatch"/> property is a flag that determines
- the behavior when a matching <see cref="T:log4net.Core.Level"/> is found. If the
- flag is set to true then the filter will <see cref="F:log4net.Filter.FilterDecision.Accept"/> the
- logging event, otherwise it will <see cref="F:log4net.Filter.FilterDecision.Deny"/> the event.
- </para>
- <para>
- The default is <c>true</c> i.e. to <see cref="F:log4net.Filter.FilterDecision.Accept"/> the event.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Filter.LevelMatchFilter.LevelToMatch">
- <summary>
- The <see cref="T:log4net.Core.Level"/> that the filter will match
- </summary>
- <remarks>
- <para>
- The level that this filter will attempt to match against the
- <see cref="T:log4net.Core.LoggingEvent"/> level. If a match is found then
- the result depends on the value of <see cref="P:log4net.Filter.LevelMatchFilter.AcceptOnMatch"/>.
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Filter.LevelRangeFilter">
- <summary>
- This is a simple filter based on <see cref="T:log4net.Core.Level"/> matching.
- </summary>
- <remarks>
- <para>
- The filter admits three options <see cref="P:log4net.Filter.LevelRangeFilter.LevelMin"/> and <see cref="P:log4net.Filter.LevelRangeFilter.LevelMax"/>
- that determine the range of priorities that are matched, and
- <see cref="P:log4net.Filter.LevelRangeFilter.AcceptOnMatch"/>. If there is a match between the range
- of priorities and the <see cref="T:log4net.Core.Level"/> of the <see cref="T:log4net.Core.LoggingEvent"/>, then the
- <see cref="M:log4net.Filter.LevelRangeFilter.Decide(log4net.Core.LoggingEvent)"/> method returns <see cref="F:log4net.Filter.FilterDecision.Accept"/> in case the <see cref="P:log4net.Filter.LevelRangeFilter.AcceptOnMatch"/>
- option value is set to <c>true</c>, if it is <c>false</c>
- then <see cref="F:log4net.Filter.FilterDecision.Deny"/> is returned. If there is no match, <see cref="F:log4net.Filter.FilterDecision.Deny"/> is returned.
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- <author>Gert Driesen</author>
- </member>
- <member name="F:log4net.Filter.LevelRangeFilter.m_acceptOnMatch">
- <summary>
- Flag to indicate the behavior when matching a <see cref="T:log4net.Core.Level"/>
- </summary>
- </member>
- <member name="F:log4net.Filter.LevelRangeFilter.m_levelMin">
- <summary>
- the minimum <see cref="T:log4net.Core.Level"/> value to match
- </summary>
- </member>
- <member name="F:log4net.Filter.LevelRangeFilter.m_levelMax">
- <summary>
- the maximum <see cref="T:log4net.Core.Level"/> value to match
- </summary>
- </member>
- <member name="M:log4net.Filter.LevelRangeFilter.#ctor">
- <summary>
- Default constructor
- </summary>
- </member>
- <member name="M:log4net.Filter.LevelRangeFilter.Decide(log4net.Core.LoggingEvent)">
- <summary>
- Check if the event should be logged.
- </summary>
- <param name="loggingEvent">the logging event to check</param>
- <returns>see remarks</returns>
- <remarks>
- <para>
- If the <see cref="T:log4net.Core.Level"/> of the logging event is outside the range
- matched by this filter then <see cref="F:log4net.Filter.FilterDecision.Deny"/>
- is returned. If the <see cref="T:log4net.Core.Level"/> is matched then the value of
- <see cref="P:log4net.Filter.LevelRangeFilter.AcceptOnMatch"/> is checked. If it is true then
- <see cref="F:log4net.Filter.FilterDecision.Accept"/> is returned, otherwise
- <see cref="F:log4net.Filter.FilterDecision.Neutral"/> is returned.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Filter.LevelRangeFilter.AcceptOnMatch">
- <summary>
- <see cref="F:log4net.Filter.FilterDecision.Accept"/> when matching <see cref="P:log4net.Filter.LevelRangeFilter.LevelMin"/> and <see cref="P:log4net.Filter.LevelRangeFilter.LevelMax"/>
- </summary>
- <remarks>
- <para>
- The <see cref="P:log4net.Filter.LevelRangeFilter.AcceptOnMatch"/> property is a flag that determines
- the behavior when a matching <see cref="T:log4net.Core.Level"/> is found. If the
- flag is set to true then the filter will <see cref="F:log4net.Filter.FilterDecision.Accept"/> the
- logging event, otherwise it will <see cref="F:log4net.Filter.FilterDecision.Neutral"/> the event.
- </para>
- <para>
- The default is <c>true</c> i.e. to <see cref="F:log4net.Filter.FilterDecision.Accept"/> the event.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Filter.LevelRangeFilter.LevelMin">
- <summary>
- Set the minimum matched <see cref="T:log4net.Core.Level"/>
- </summary>
- <remarks>
- <para>
- The minimum level that this filter will attempt to match against the
- <see cref="T:log4net.Core.LoggingEvent"/> level. If a match is found then
- the result depends on the value of <see cref="P:log4net.Filter.LevelRangeFilter.AcceptOnMatch"/>.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Filter.LevelRangeFilter.LevelMax">
- <summary>
- Sets the maximum matched <see cref="T:log4net.Core.Level"/>
- </summary>
- <remarks>
- <para>
- The maximum level that this filter will attempt to match against the
- <see cref="T:log4net.Core.LoggingEvent"/> level. If a match is found then
- the result depends on the value of <see cref="P:log4net.Filter.LevelRangeFilter.AcceptOnMatch"/>.
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Filter.LoggerMatchFilter">
- <summary>
- Simple filter to match a string in the event's logger name.
- </summary>
- <remarks>
- <para>
- The works very similar to the <see cref="T:log4net.Filter.LevelMatchFilter"/>. It admits two
- options <see cref="P:log4net.Filter.LoggerMatchFilter.LoggerToMatch"/> and <see cref="P:log4net.Filter.LoggerMatchFilter.AcceptOnMatch"/>. If the
- <see cref="P:log4net.Core.LoggingEvent.LoggerName"/> of the <see cref="T:log4net.Core.LoggingEvent"/> starts
- with the value of the <see cref="P:log4net.Filter.LoggerMatchFilter.LoggerToMatch"/> option, then the
- <see cref="M:log4net.Filter.LoggerMatchFilter.Decide(log4net.Core.LoggingEvent)"/> method returns <see cref="F:log4net.Filter.FilterDecision.Accept"/> in
- case the <see cref="P:log4net.Filter.LoggerMatchFilter.AcceptOnMatch"/> option value is set to <c>true</c>,
- if it is <c>false</c> then <see cref="F:log4net.Filter.FilterDecision.Deny"/> is returned.
- </para>
- </remarks>
- <author>Daniel Cazzulino</author>
- </member>
- <member name="F:log4net.Filter.LoggerMatchFilter.m_acceptOnMatch">
- <summary>
- Flag to indicate the behavior when we have a match
- </summary>
- </member>
- <member name="F:log4net.Filter.LoggerMatchFilter.m_loggerToMatch">
- <summary>
- The logger name string to substring match against the event
- </summary>
- </member>
- <member name="M:log4net.Filter.LoggerMatchFilter.#ctor">
- <summary>
- Default constructor
- </summary>
- </member>
- <member name="M:log4net.Filter.LoggerMatchFilter.Decide(log4net.Core.LoggingEvent)">
- <summary>
- Check if this filter should allow the event to be logged
- </summary>
- <param name="loggingEvent">the event being logged</param>
- <returns>see remarks</returns>
- <remarks>
- <para>
- The rendered message is matched against the <see cref="P:log4net.Filter.LoggerMatchFilter.LoggerToMatch"/>.
- If the <see cref="P:log4net.Filter.LoggerMatchFilter.LoggerToMatch"/> equals the beginning of
- the incoming <see cref="P:log4net.Core.LoggingEvent.LoggerName"/> (<see cref="M:String.StartsWith(string)"/>)
- then a match will have occurred. If no match occurs
- this function will return <see cref="F:log4net.Filter.FilterDecision.Neutral"/>
- allowing other filters to check the event. If a match occurs then
- the value of <see cref="P:log4net.Filter.LoggerMatchFilter.AcceptOnMatch"/> is checked. If it is
- true then <see cref="F:log4net.Filter.FilterDecision.Accept"/> is returned otherwise
- <see cref="F:log4net.Filter.FilterDecision.Deny"/> is returned.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Filter.LoggerMatchFilter.AcceptOnMatch">
- <summary>
- <see cref="F:log4net.Filter.FilterDecision.Accept"/> when matching <see cref="P:log4net.Filter.LoggerMatchFilter.LoggerToMatch"/>
- </summary>
- <remarks>
- <para>
- The <see cref="P:log4net.Filter.LoggerMatchFilter.AcceptOnMatch"/> property is a flag that determines
- the behavior when a matching <see cref="T:log4net.Core.Level"/> is found. If the
- flag is set to true then the filter will <see cref="F:log4net.Filter.FilterDecision.Accept"/> the
- logging event, otherwise it will <see cref="F:log4net.Filter.FilterDecision.Deny"/> the event.
- </para>
- <para>
- The default is <c>true</c> i.e. to <see cref="F:log4net.Filter.FilterDecision.Accept"/> the event.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Filter.LoggerMatchFilter.LoggerToMatch">
- <summary>
- The <see cref="P:log4net.Core.LoggingEvent.LoggerName"/> that the filter will match
- </summary>
- <remarks>
- <para>
- This filter will attempt to match this value against logger name in
- the following way. The match will be done against the beginning of the
- logger name (using <see cref="M:String.StartsWith(string)"/>). The match is
- case sensitive. If a match is found then
- the result depends on the value of <see cref="P:log4net.Filter.LoggerMatchFilter.AcceptOnMatch"/>.
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Filter.MdcFilter">
- <summary>
- Simple filter to match a keyed string in the <see cref="T:log4net.MDC"/>
- </summary>
- <remarks>
- <para>
- Simple filter to match a keyed string in the <see cref="T:log4net.MDC"/>
- </para>
- <para>
- As the MDC has been replaced with layered properties the
- <see cref="T:log4net.Filter.PropertyFilter"/> should be used instead.
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- <author>Gert Driesen</author>
- </member>
- <member name="T:log4net.Filter.PropertyFilter">
- <summary>
- Simple filter to match a string an event property
- </summary>
- <remarks>
- <para>
- Simple filter to match a string in the value for a
- specific event property
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- </member>
- <member name="T:log4net.Filter.StringMatchFilter">
- <summary>
- Simple filter to match a string in the rendered message
- </summary>
- <remarks>
- <para>
- Simple filter to match a string in the rendered message
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- <author>Gert Driesen</author>
- </member>
- <member name="F:log4net.Filter.StringMatchFilter.m_acceptOnMatch">
- <summary>
- Flag to indicate the behavior when we have a match
- </summary>
- </member>
- <member name="F:log4net.Filter.StringMatchFilter.m_stringToMatch">
- <summary>
- The string to substring match against the message
- </summary>
- </member>
- <member name="F:log4net.Filter.StringMatchFilter.m_stringRegexToMatch">
- <summary>
- A string regex to match
- </summary>
- </member>
- <member name="F:log4net.Filter.StringMatchFilter.m_regexToMatch">
- <summary>
- A regex object to match (generated from m_stringRegexToMatch)
- </summary>
- </member>
- <member name="M:log4net.Filter.StringMatchFilter.#ctor">
- <summary>
- Default constructor
- </summary>
- </member>
- <member name="M:log4net.Filter.StringMatchFilter.ActivateOptions">
- <summary>
- Initialize and precompile the Regex if required
- </summary>
- <remarks>
- <para>
- This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
- activation scheme. The <see cref="M:log4net.Filter.StringMatchFilter.ActivateOptions"/> method must
- be called on this object after the configuration properties have
- been set. Until <see cref="M:log4net.Filter.StringMatchFilter.ActivateOptions"/> is called this
- object is in an undefined state and must not be used.
- </para>
- <para>
- If any of the configuration properties are modified then
- <see cref="M:log4net.Filter.StringMatchFilter.ActivateOptions"/> must be called again.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Filter.StringMatchFilter.Decide(log4net.Core.LoggingEvent)">
- <summary>
- Check if this filter should allow the event to be logged
- </summary>
- <param name="loggingEvent">the event being logged</param>
- <returns>see remarks</returns>
- <remarks>
- <para>
- The rendered message is matched against the <see cref="P:log4net.Filter.StringMatchFilter.StringToMatch"/>.
- If the <see cref="P:log4net.Filter.StringMatchFilter.StringToMatch"/> occurs as a substring within
- the message then a match will have occurred. If no match occurs
- this function will return <see cref="F:log4net.Filter.FilterDecision.Neutral"/>
- allowing other filters to check the event. If a match occurs then
- the value of <see cref="P:log4net.Filter.StringMatchFilter.AcceptOnMatch"/> is checked. If it is
- true then <see cref="F:log4net.Filter.FilterDecision.Accept"/> is returned otherwise
- <see cref="F:log4net.Filter.FilterDecision.Deny"/> is returned.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Filter.StringMatchFilter.AcceptOnMatch">
- <summary>
- <see cref="F:log4net.Filter.FilterDecision.Accept"/> when matching <see cref="P:log4net.Filter.StringMatchFilter.StringToMatch"/> or <see cref="P:log4net.Filter.StringMatchFilter.RegexToMatch"/>
- </summary>
- <remarks>
- <para>
- The <see cref="P:log4net.Filter.StringMatchFilter.AcceptOnMatch"/> property is a flag that determines
- the behavior when a matching <see cref="T:log4net.Core.Level"/> is found. If the
- flag is set to true then the filter will <see cref="F:log4net.Filter.FilterDecision.Accept"/> the
- logging event, otherwise it will <see cref="F:log4net.Filter.FilterDecision.Neutral"/> the event.
- </para>
- <para>
- The default is <c>true</c> i.e. to <see cref="F:log4net.Filter.FilterDecision.Accept"/> the event.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Filter.StringMatchFilter.StringToMatch">
- <summary>
- Sets the static string to match
- </summary>
- <remarks>
- <para>
- The string that will be substring matched against
- the rendered message. If the message contains this
- string then the filter will match. If a match is found then
- the result depends on the value of <see cref="P:log4net.Filter.StringMatchFilter.AcceptOnMatch"/>.
- </para>
- <para>
- One of <see cref="P:log4net.Filter.StringMatchFilter.StringToMatch"/> or <see cref="P:log4net.Filter.StringMatchFilter.RegexToMatch"/>
- must be specified.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Filter.StringMatchFilter.RegexToMatch">
- <summary>
- Sets the regular expression to match
- </summary>
- <remarks>
- <para>
- The regular expression pattern that will be matched against
- the rendered message. If the message matches this
- pattern then the filter will match. If a match is found then
- the result depends on the value of <see cref="P:log4net.Filter.StringMatchFilter.AcceptOnMatch"/>.
- </para>
- <para>
- One of <see cref="P:log4net.Filter.StringMatchFilter.StringToMatch"/> or <see cref="P:log4net.Filter.StringMatchFilter.RegexToMatch"/>
- must be specified.
- </para>
- </remarks>
- </member>
- <member name="F:log4net.Filter.PropertyFilter.m_key">
- <summary>
- The key to use to lookup the string from the event properties
- </summary>
- </member>
- <member name="M:log4net.Filter.PropertyFilter.#ctor">
- <summary>
- Default constructor
- </summary>
- </member>
- <member name="M:log4net.Filter.PropertyFilter.Decide(log4net.Core.LoggingEvent)">
- <summary>
- Check if this filter should allow the event to be logged
- </summary>
- <param name="loggingEvent">the event being logged</param>
- <returns>see remarks</returns>
- <remarks>
- <para>
- The event property for the <see cref="P:log4net.Filter.PropertyFilter.Key"/> is matched against
- the <see cref="P:log4net.Filter.StringMatchFilter.StringToMatch"/>.
- If the <see cref="P:log4net.Filter.StringMatchFilter.StringToMatch"/> occurs as a substring within
- the property value then a match will have occurred. If no match occurs
- this function will return <see cref="F:log4net.Filter.FilterDecision.Neutral"/>
- allowing other filters to check the event. If a match occurs then
- the value of <see cref="P:log4net.Filter.StringMatchFilter.AcceptOnMatch"/> is checked. If it is
- true then <see cref="F:log4net.Filter.FilterDecision.Accept"/> is returned otherwise
- <see cref="F:log4net.Filter.FilterDecision.Deny"/> is returned.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Filter.PropertyFilter.Key">
- <summary>
- The key to lookup in the event properties and then match against.
- </summary>
- <remarks>
- <para>
- The key name to use to lookup in the properties map of the
- <see cref="T:log4net.Core.LoggingEvent"/>. The match will be performed against
- the value of this property if it exists.
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Filter.NdcFilter">
- <summary>
- Simple filter to match a string in the <see cref="T:log4net.NDC"/>
- </summary>
- <remarks>
- <para>
- Simple filter to match a string in the <see cref="T:log4net.NDC"/>
- </para>
- <para>
- As the MDC has been replaced with named stacks stored in the
- properties collections the <see cref="T:log4net.Filter.PropertyFilter"/> should
- be used instead.
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- <author>Gert Driesen</author>
- </member>
- <member name="M:log4net.Filter.NdcFilter.#ctor">
- <summary>
- Default constructor
- </summary>
- <remarks>
- <para>
- Sets the <see cref="P:log4net.Filter.PropertyFilter.Key"/> to <c>"NDC"</c>.
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Layout.Pattern.AppDomainPatternConverter">
- <summary>
- Write the event appdomain name to the output
- </summary>
- <remarks>
- <para>
- Writes the <see cref="P:log4net.Core.LoggingEvent.Domain"/> to the output writer.
- </para>
- </remarks>
- <author>Daniel Cazzulino</author>
- <author>Nicko Cadell</author>
- </member>
- <member name="T:log4net.Layout.Pattern.PatternLayoutConverter">
- <summary>
- Abstract class that provides the formatting functionality that
- derived classes need.
- </summary>
- <remarks>
- Conversion specifiers in a conversion patterns are parsed to
- individual PatternConverters. Each of which is responsible for
- converting a logging event in a converter specific manner.
- </remarks>
- <author>Nicko Cadell</author>
- </member>
- <member name="T:log4net.Util.PatternConverter">
- <summary>
- Abstract class that provides the formatting functionality that
- derived classes need.
- </summary>
- <remarks>
- <para>
- Conversion specifiers in a conversion patterns are parsed to
- individual PatternConverters. Each of which is responsible for
- converting a logging event in a converter specific manner.
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- <author>Gert Driesen</author>
- </member>
- <member name="F:log4net.Util.PatternConverter.c_renderBufferSize">
- <summary>
- Initial buffer size
- </summary>
- </member>
- <member name="F:log4net.Util.PatternConverter.c_renderBufferMaxCapacity">
- <summary>
- Maximum buffer size before it is recycled
- </summary>
- </member>
- <member name="M:log4net.Util.PatternConverter.#ctor">
- <summary>
- Protected constructor
- </summary>
- <remarks>
- <para>
- Initializes a new instance of the <see cref="T:log4net.Util.PatternConverter"/> class.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.PatternConverter.Convert(System.IO.TextWriter,System.Object)">
- <summary>
- Evaluate this pattern converter and write the output to a writer.
- </summary>
- <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
- <param name="state">The state object on which the pattern converter should be executed.</param>
- <remarks>
- <para>
- Derived pattern converters must override this method in order to
- convert conversion specifiers in the appropriate way.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.PatternConverter.SetNext(log4net.Util.PatternConverter)">
- <summary>
- Set the next pattern converter in the chains
- </summary>
- <param name="patternConverter">the pattern converter that should follow this converter in the chain</param>
- <returns>the next converter</returns>
- <remarks>
- <para>
- The PatternConverter can merge with its neighbor during this method (or a sub class).
- Therefore the return value may or may not be the value of the argument passed in.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.PatternConverter.Format(System.IO.TextWriter,System.Object)">
- <summary>
- Write the pattern converter to the writer with appropriate formatting
- </summary>
- <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
- <param name="state">The state object on which the pattern converter should be executed.</param>
- <remarks>
- <para>
- This method calls <see cref="M:log4net.Util.PatternConverter.Convert(System.IO.TextWriter,System.Object)"/> to allow the subclass to perform
- appropriate conversion of the pattern converter. If formatting options have
- been specified via the <see cref="P:log4net.Util.PatternConverter.FormattingInfo"/> then this method will
- apply those formattings before writing the output.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.PatternConverter.SpacePad(System.IO.TextWriter,System.Int32)">
- <summary>
- Fast space padding method.
- </summary>
- <param name="writer"><see cref="T:System.IO.TextWriter"/> to which the spaces will be appended.</param>
- <param name="length">The number of spaces to be padded.</param>
- <remarks>
- <para>
- Fast space padding method.
- </para>
- </remarks>
- </member>
- <member name="F:log4net.Util.PatternConverter.m_option">
- <summary>
- The option string to the converter
- </summary>
- </member>
- <member name="M:log4net.Util.PatternConverter.WriteDictionary(System.IO.TextWriter,log4net.Repository.ILoggerRepository,System.Collections.IDictionary)">
- <summary>
- Write an dictionary to a <see cref="T:System.IO.TextWriter"/>
- </summary>
- <param name="writer">the writer to write to</param>
- <param name="repository">a <see cref="T:log4net.Repository.ILoggerRepository"/> to use for object conversion</param>
- <param name="value">the value to write to the writer</param>
- <remarks>
- <para>
- Writes the <see cref="T:System.Collections.IDictionary"/> to a writer in the form:
- </para>
- <code>
- {key1=value1, key2=value2, key3=value3}
- </code>
- <para>
- If the <see cref="T:log4net.Repository.ILoggerRepository"/> specified
- is not null then it is used to render the key and value to text, otherwise
- the object's ToString method is called.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.PatternConverter.WriteDictionary(System.IO.TextWriter,log4net.Repository.ILoggerRepository,System.Collections.IDictionaryEnumerator)">
- <summary>
- Write an dictionary to a <see cref="T:System.IO.TextWriter"/>
- </summary>
- <param name="writer">the writer to write to</param>
- <param name="repository">a <see cref="T:log4net.Repository.ILoggerRepository"/> to use for object conversion</param>
- <param name="value">the value to write to the writer</param>
- <remarks>
- <para>
- Writes the <see cref="T:System.Collections.IDictionaryEnumerator"/> to a writer in the form:
- </para>
- <code>
- {key1=value1, key2=value2, key3=value3}
- </code>
- <para>
- If the <see cref="T:log4net.Repository.ILoggerRepository"/> specified
- is not null then it is used to render the key and value to text, otherwise
- the object's ToString method is called.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.PatternConverter.WriteObject(System.IO.TextWriter,log4net.Repository.ILoggerRepository,System.Object)">
- <summary>
- Write an object to a <see cref="T:System.IO.TextWriter"/>
- </summary>
- <param name="writer">the writer to write to</param>
- <param name="repository">a <see cref="T:log4net.Repository.ILoggerRepository"/> to use for object conversion</param>
- <param name="value">the value to write to the writer</param>
- <remarks>
- <para>
- Writes the Object to a writer. If the <see cref="T:log4net.Repository.ILoggerRepository"/> specified
- is not null then it is used to render the object to text, otherwise
- the object's ToString method is called.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Util.PatternConverter.Next">
- <summary>
- Get the next pattern converter in the chain
- </summary>
- <value>
- the next pattern converter in the chain
- </value>
- <remarks>
- <para>
- Get the next pattern converter in the chain
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Util.PatternConverter.FormattingInfo">
- <summary>
- Gets or sets the formatting info for this converter
- </summary>
- <value>
- The formatting info for this converter
- </value>
- <remarks>
- <para>
- Gets or sets the formatting info for this converter
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Util.PatternConverter.Option">
- <summary>
- Gets or sets the option value for this converter
- </summary>
- <summary>
- The option for this converter
- </summary>
- <remarks>
- <para>
- Gets or sets the option value for this converter
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Util.PatternConverter.Properties">
- <summary>
-
- </summary>
- </member>
- <member name="M:log4net.Layout.Pattern.PatternLayoutConverter.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:log4net.Layout.Pattern.PatternLayoutConverter"/> class.
- </summary>
- </member>
- <member name="M:log4net.Layout.Pattern.PatternLayoutConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
- <summary>
- Derived pattern converters must override this method in order to
- convert conversion specifiers in the correct way.
- </summary>
- <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
- <param name="loggingEvent">The <see cref="T:log4net.Core.LoggingEvent"/> on which the pattern converter should be executed.</param>
- </member>
- <member name="M:log4net.Layout.Pattern.PatternLayoutConverter.Convert(System.IO.TextWriter,System.Object)">
- <summary>
- Derived pattern converters must override this method in order to
- convert conversion specifiers in the correct way.
- </summary>
- <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
- <param name="state">The state object on which the pattern converter should be executed.</param>
- </member>
- <member name="F:log4net.Layout.Pattern.PatternLayoutConverter.m_ignoresException">
- <summary>
- Flag indicating if this converter handles exceptions
- </summary>
- <remarks>
- <c>false</c> if this converter handles exceptions
- </remarks>
- </member>
- <member name="P:log4net.Layout.Pattern.PatternLayoutConverter.IgnoresException">
- <summary>
- Flag indicating if this converter handles the logging event exception
- </summary>
- <value><c>false</c> if this converter handles the logging event exception</value>
- <remarks>
- <para>
- If this converter handles the exception object contained within
- <see cref="T:log4net.Core.LoggingEvent"/>, then this property should be set to
- <c>false</c>. Otherwise, if the layout ignores the exception
- object, then the property should be set to <c>true</c>.
- </para>
- <para>
- Set this value to override a this default setting. The default
- value is <c>true</c>, this converter does not handle the exception.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Layout.Pattern.AppDomainPatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
- <summary>
- Write the event appdomain name to the output
- </summary>
- <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
- <param name="loggingEvent">the event being logged</param>
- <remarks>
- <para>
- Writes the <see cref="P:log4net.Core.LoggingEvent.Domain"/> to the output <paramref name="writer"/>.
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Layout.Pattern.AspNetCachePatternConverter">
- <summary>
- Converter for items in the ASP.Net Cache.
- </summary>
- <remarks>
- <para>
- Outputs an item from the <see cref="P:System.Web.HttpRuntime.Cache"/>.
- </para>
- </remarks>
- <author>Ron Grabowski</author>
- </member>
- <member name="T:log4net.Layout.Pattern.AspNetPatternLayoutConverter">
- <summary>
- Abstract class that provides access to the current HttpContext (<see cref="P:System.Web.HttpContext.Current"/>) that
- derived classes need.
- </summary>
- <remarks>
- This class handles the case when HttpContext.Current is null by writing
- <see cref="P:log4net.Util.SystemInfo.NotAvailableText"/> to the writer.
- </remarks>
- <author>Ron Grabowski</author>
- </member>
- <member name="M:log4net.Layout.Pattern.AspNetPatternLayoutConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent,System.Web.HttpContext)">
- <summary>
- Derived pattern converters must override this method in order to
- convert conversion specifiers in the correct way.
- </summary>
- <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
- <param name="loggingEvent">The <see cref="T:log4net.Core.LoggingEvent"/> on which the pattern converter should be executed.</param>
- <param name="httpContext">The <see cref="T:System.Web.HttpContext"/> under which the ASP.Net request is running.</param>
- </member>
- <member name="M:log4net.Layout.Pattern.AspNetCachePatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent,System.Web.HttpContext)">
- <summary>
- Write the ASP.Net Cache item to the output
- </summary>
- <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
- <param name="loggingEvent">The <see cref="T:log4net.Core.LoggingEvent"/> on which the pattern converter should be executed.</param>
- <param name="httpContext">The <see cref="T:System.Web.HttpContext"/> under which the ASP.Net request is running.</param>
- <remarks>
- <para>
- Writes out the value of a named property. The property name
- should be set in the <see cref="P:log4net.Util.PatternConverter.Option"/>
- property. If no property has been set, all key value pairs from the Cache will
- be written to the output.
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Layout.Pattern.AspNetContextPatternConverter">
- <summary>
- Converter for items in the <see cref="T:System.Web.HttpContext"/>.
- </summary>
- <remarks>
- <para>
- Outputs an item from the <see cref="T:System.Web.HttpContext"/>.
- </para>
- </remarks>
- <author>Ron Grabowski</author>
- </member>
- <member name="M:log4net.Layout.Pattern.AspNetContextPatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent,System.Web.HttpContext)">
- <summary>
- Write the ASP.Net HttpContext item to the output
- </summary>
- <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
- <param name="loggingEvent">The <see cref="T:log4net.Core.LoggingEvent"/> on which the pattern converter should be executed.</param>
- <param name="httpContext">The <see cref="T:System.Web.HttpContext"/> under which the ASP.Net request is running.</param>
- <remarks>
- <para>
- Writes out the value of a named property. The property name
- should be set in the <see cref="P:log4net.Util.PatternConverter.Option"/>
- property.
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Layout.Pattern.AspNetRequestPatternConverter">
- <summary>
- Converter for items in the ASP.Net Cache.
- </summary>
- <remarks>
- <para>
- Outputs an item from the <see cref="P:System.Web.HttpRuntime.Cache"/>.
- </para>
- </remarks>
- <author>Ron Grabowski</author>
- </member>
- <member name="M:log4net.Layout.Pattern.AspNetRequestPatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent,System.Web.HttpContext)">
- <summary>
- Write the ASP.Net Cache item to the output
- </summary>
- <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
- <param name="loggingEvent">The <see cref="T:log4net.Core.LoggingEvent"/> on which the pattern converter should be executed.</param>
- <param name="httpContext">The <see cref="T:System.Web.HttpContext"/> under which the ASP.Net request is running.</param>
- <remarks>
- <para>
- Writes out the value of a named property. The property name
- should be set in the <see cref="P:log4net.Util.PatternConverter.Option"/>
- property.
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Layout.Pattern.AspNetSessionPatternConverter">
- <summary>
- Converter for items in the ASP.Net Cache.
- </summary>
- <remarks>
- <para>
- Outputs an item from the <see cref="P:System.Web.HttpRuntime.Cache"/>.
- </para>
- </remarks>
- <author>Ron Grabowski</author>
- </member>
- <member name="M:log4net.Layout.Pattern.AspNetSessionPatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent,System.Web.HttpContext)">
- <summary>
- Write the ASP.Net Cache item to the output
- </summary>
- <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
- <param name="loggingEvent">The <see cref="T:log4net.Core.LoggingEvent"/> on which the pattern converter should be executed.</param>
- <param name="httpContext">The <see cref="T:System.Web.HttpContext"/> under which the ASP.Net request is running.</param>
- <remarks>
- <para>
- Writes out the value of a named property. The property name
- should be set in the <see cref="P:log4net.Util.PatternConverter.Option"/>
- property. If no property has been set, all key value pairs from the Session will
- be written to the output.
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Layout.Pattern.DatePatternConverter">
- <summary>
- Date pattern converter, uses a <see cref="T:log4net.DateFormatter.IDateFormatter"/> to format
- the date of a <see cref="T:log4net.Core.LoggingEvent"/>.
- </summary>
- <remarks>
- <para>
- Render the <see cref="P:log4net.Core.LoggingEvent.TimeStamp"/> to the writer as a string.
- </para>
- <para>
- The value of the <see cref="P:log4net.Util.PatternConverter.Option"/> determines
- the formatting of the date. The following values are allowed:
- <list type="definition">
- <listheader>
- <term>Option value</term>
- <description>Output</description>
- </listheader>
- <item>
- <term>ISO8601</term>
- <description>
- Uses the <see cref="T:log4net.DateFormatter.Iso8601DateFormatter"/> formatter.
- Formats using the <c>"yyyy-MM-dd HH:mm:ss,fff"</c> pattern.
- </description>
- </item>
- <item>
- <term>DATE</term>
- <description>
- Uses the <see cref="T:log4net.DateFormatter.DateTimeDateFormatter"/> formatter.
- Formats using the <c>"dd MMM yyyy HH:mm:ss,fff"</c> for example, <c>"06 Nov 1994 15:49:37,459"</c>.
- </description>
- </item>
- <item>
- <term>ABSOLUTE</term>
- <description>
- Uses the <see cref="T:log4net.DateFormatter.AbsoluteTimeDateFormatter"/> formatter.
- Formats using the <c>"HH:mm:ss,yyyy"</c> for example, <c>"15:49:37,459"</c>.
- </description>
- </item>
- <item>
- <term>other</term>
- <description>
- Any other pattern string uses the <see cref="T:log4net.DateFormatter.SimpleDateFormatter"/> formatter.
- This formatter passes the pattern string to the <see cref="T:System.DateTime"/>
- <see cref="M:DateTime.ToString(string)"/> method.
- For details on valid patterns see
- <a href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpref/html/frlrfsystemglobalizationdatetimeformatinfoclasstopic.asp">DateTimeFormatInfo Class</a>.
- </description>
- </item>
- </list>
- </para>
- <para>
- The <see cref="P:log4net.Core.LoggingEvent.TimeStamp"/> is in the local time zone and is rendered in that zone.
- To output the time in Universal time see <see cref="T:log4net.Layout.Pattern.UtcDatePatternConverter"/>.
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- </member>
- <member name="F:log4net.Layout.Pattern.DatePatternConverter.m_dateFormatter">
- <summary>
- The <see cref="T:log4net.DateFormatter.IDateFormatter"/> used to render the date to a string
- </summary>
- <remarks>
- <para>
- The <see cref="T:log4net.DateFormatter.IDateFormatter"/> used to render the date to a string
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Layout.Pattern.DatePatternConverter.ActivateOptions">
- <summary>
- Initialize the converter pattern based on the <see cref="P:log4net.Util.PatternConverter.Option"/> property.
- </summary>
- <remarks>
- <para>
- This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
- activation scheme. The <see cref="M:log4net.Layout.Pattern.DatePatternConverter.ActivateOptions"/> method must
- be called on this object after the configuration properties have
- been set. Until <see cref="M:log4net.Layout.Pattern.DatePatternConverter.ActivateOptions"/> is called this
- object is in an undefined state and must not be used.
- </para>
- <para>
- If any of the configuration properties are modified then
- <see cref="M:log4net.Layout.Pattern.DatePatternConverter.ActivateOptions"/> must be called again.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Layout.Pattern.DatePatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
- <summary>
- Convert the pattern into the rendered message
- </summary>
- <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
- <param name="loggingEvent">the event being logged</param>
- <remarks>
- <para>
- Pass the <see cref="P:log4net.Core.LoggingEvent.TimeStamp"/> to the <see cref="T:log4net.DateFormatter.IDateFormatter"/>
- for it to render it to the writer.
- </para>
- <para>
- The <see cref="P:log4net.Core.LoggingEvent.TimeStamp"/> passed is in the local time zone.
- </para>
- </remarks>
- </member>
- <member name="F:log4net.Layout.Pattern.DatePatternConverter.declaringType">
- <summary>
- The fully qualified type of the DatePatternConverter class.
- </summary>
- <remarks>
- Used by the internal logger to record the Type of the
- log message.
- </remarks>
- </member>
- <member name="T:log4net.Layout.Pattern.ExceptionPatternConverter">
- <summary>
- Write the exception text to the output
- </summary>
- <remarks>
- <para>
- If an exception object is stored in the logging event
- it will be rendered into the pattern output with a
- trailing newline.
- </para>
- <para>
- If there is no exception then nothing will be output
- and no trailing newline will be appended.
- It is typical to put a newline before the exception
- and to have the exception as the last data in the pattern.
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- </member>
- <member name="M:log4net.Layout.Pattern.ExceptionPatternConverter.#ctor">
- <summary>
- Default constructor
- </summary>
- </member>
- <member name="M:log4net.Layout.Pattern.ExceptionPatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
- <summary>
- Write the exception text to the output
- </summary>
- <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
- <param name="loggingEvent">the event being logged</param>
- <remarks>
- <para>
- If an exception object is stored in the logging event
- it will be rendered into the pattern output with a
- trailing newline.
- </para>
- <para>
- If there is no exception or the exception property specified
- by the Option value does not exist then nothing will be output
- and no trailing newline will be appended.
- It is typical to put a newline before the exception
- and to have the exception as the last data in the pattern.
- </para>
- <para>
- Recognized values for the Option parameter are:
- </para>
- <list type="bullet">
- <item>
- <description>Message</description>
- </item>
- <item>
- <description>Source</description>
- </item>
- <item>
- <description>StackTrace</description>
- </item>
- <item>
- <description>TargetSite</description>
- </item>
- <item>
- <description>HelpLink</description>
- </item>
- </list>
- </remarks>
- </member>
- <member name="T:log4net.Layout.Pattern.FileLocationPatternConverter">
- <summary>
- Writes the caller location file name to the output
- </summary>
- <remarks>
- <para>
- Writes the value of the <see cref="P:log4net.Core.LocationInfo.FileName"/> for
- the event to the output writer.
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- </member>
- <member name="M:log4net.Layout.Pattern.FileLocationPatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
- <summary>
- Write the caller location file name to the output
- </summary>
- <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
- <param name="loggingEvent">the event being logged</param>
- <remarks>
- <para>
- Writes the value of the <see cref="P:log4net.Core.LocationInfo.FileName"/> for
- the <paramref name="loggingEvent"/> to the output <paramref name="writer"/>.
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Layout.Pattern.FullLocationPatternConverter">
- <summary>
- Write the caller location info to the output
- </summary>
- <remarks>
- <para>
- Writes the <see cref="P:log4net.Core.LocationInfo.FullInfo"/> to the output writer.
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- </member>
- <member name="M:log4net.Layout.Pattern.FullLocationPatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
- <summary>
- Write the caller location info to the output
- </summary>
- <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
- <param name="loggingEvent">the event being logged</param>
- <remarks>
- <para>
- Writes the <see cref="P:log4net.Core.LocationInfo.FullInfo"/> to the output writer.
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Layout.Pattern.IdentityPatternConverter">
- <summary>
- Writes the event identity to the output
- </summary>
- <remarks>
- <para>
- Writes the value of the <see cref="P:log4net.Core.LoggingEvent.Identity"/> to
- the output writer.
- </para>
- </remarks>
- <author>Daniel Cazzulino</author>
- <author>Nicko Cadell</author>
- </member>
- <member name="M:log4net.Layout.Pattern.IdentityPatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
- <summary>
- Writes the event identity to the output
- </summary>
- <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
- <param name="loggingEvent">the event being logged</param>
- <remarks>
- <para>
- Writes the value of the <paramref name="loggingEvent"/>
- <see cref="P:log4net.Core.LoggingEvent.Identity"/> to
- the output <paramref name="writer"/>.
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Layout.Pattern.LevelPatternConverter">
- <summary>
- Write the event level to the output
- </summary>
- <remarks>
- <para>
- Writes the display name of the event <see cref="P:log4net.Core.LoggingEvent.Level"/>
- to the writer.
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- </member>
- <member name="M:log4net.Layout.Pattern.LevelPatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
- <summary>
- Write the event level to the output
- </summary>
- <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
- <param name="loggingEvent">the event being logged</param>
- <remarks>
- <para>
- Writes the <see cref="P:log4net.Core.Level.DisplayName"/> of the <paramref name="loggingEvent"/> <see cref="P:log4net.Core.LoggingEvent.Level"/>
- to the <paramref name="writer"/>.
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Layout.Pattern.LineLocationPatternConverter">
- <summary>
- Write the caller location line number to the output
- </summary>
- <remarks>
- <para>
- Writes the value of the <see cref="P:log4net.Core.LocationInfo.LineNumber"/> for
- the event to the output writer.
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- </member>
- <member name="M:log4net.Layout.Pattern.LineLocationPatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
- <summary>
- Write the caller location line number to the output
- </summary>
- <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
- <param name="loggingEvent">the event being logged</param>
- <remarks>
- <para>
- Writes the value of the <see cref="P:log4net.Core.LocationInfo.LineNumber"/> for
- the <paramref name="loggingEvent"/> to the output <paramref name="writer"/>.
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Layout.Pattern.LoggerPatternConverter">
- <summary>
- Converter for logger name
- </summary>
- <remarks>
- <para>
- Outputs the <see cref="P:log4net.Core.LoggingEvent.LoggerName"/> of the event.
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- </member>
- <member name="T:log4net.Layout.Pattern.NamedPatternConverter">
- <summary>
- Converter to output and truncate <c>'.'</c> separated strings
- </summary>
- <remarks>
- <para>
- This abstract class supports truncating a <c>'.'</c> separated string
- to show a specified number of elements from the right hand side.
- This is used to truncate class names that are fully qualified.
- </para>
- <para>
- Subclasses should override the <see cref="M:log4net.Layout.Pattern.NamedPatternConverter.GetFullyQualifiedName(log4net.Core.LoggingEvent)"/> method to
- return the fully qualified string.
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- </member>
- <member name="M:log4net.Layout.Pattern.NamedPatternConverter.ActivateOptions">
- <summary>
- Initialize the converter
- </summary>
- <remarks>
- <para>
- This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
- activation scheme. The <see cref="M:log4net.Layout.Pattern.NamedPatternConverter.ActivateOptions"/> method must
- be called on this object after the configuration properties have
- been set. Until <see cref="M:log4net.Layout.Pattern.NamedPatternConverter.ActivateOptions"/> is called this
- object is in an undefined state and must not be used.
- </para>
- <para>
- If any of the configuration properties are modified then
- <see cref="M:log4net.Layout.Pattern.NamedPatternConverter.ActivateOptions"/> must be called again.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Layout.Pattern.NamedPatternConverter.GetFullyQualifiedName(log4net.Core.LoggingEvent)">
- <summary>
- Get the fully qualified string data
- </summary>
- <param name="loggingEvent">the event being logged</param>
- <returns>the fully qualified name</returns>
- <remarks>
- <para>
- Overridden by subclasses to get the fully qualified name before the
- precision is applied to it.
- </para>
- <para>
- Return the fully qualified <c>'.'</c> (dot/period) separated string.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Layout.Pattern.NamedPatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
- <summary>
- Convert the pattern to the rendered message
- </summary>
- <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
- <param name="loggingEvent">the event being logged</param>
- <remarks>
- Render the <see cref="M:log4net.Layout.Pattern.NamedPatternConverter.GetFullyQualifiedName(log4net.Core.LoggingEvent)"/> to the precision
- specified by the <see cref="P:log4net.Util.PatternConverter.Option"/> property.
- </remarks>
- </member>
- <member name="F:log4net.Layout.Pattern.NamedPatternConverter.declaringType">
- <summary>
- The fully qualified type of the NamedPatternConverter class.
- </summary>
- <remarks>
- Used by the internal logger to record the Type of the
- log message.
- </remarks>
- </member>
- <member name="M:log4net.Layout.Pattern.LoggerPatternConverter.GetFullyQualifiedName(log4net.Core.LoggingEvent)">
- <summary>
- Gets the fully qualified name of the logger
- </summary>
- <param name="loggingEvent">the event being logged</param>
- <returns>The fully qualified logger name</returns>
- <remarks>
- <para>
- Returns the <see cref="P:log4net.Core.LoggingEvent.LoggerName"/> of the <paramref name="loggingEvent"/>.
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Layout.Pattern.MessagePatternConverter">
- <summary>
- Writes the event message to the output
- </summary>
- <remarks>
- <para>
- Uses the <see cref="M:log4net.Core.LoggingEvent.WriteRenderedMessage(System.IO.TextWriter)"/> method
- to write out the event message.
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- </member>
- <member name="M:log4net.Layout.Pattern.MessagePatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
- <summary>
- Writes the event message to the output
- </summary>
- <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
- <param name="loggingEvent">the event being logged</param>
- <remarks>
- <para>
- Uses the <see cref="M:log4net.Core.LoggingEvent.WriteRenderedMessage(System.IO.TextWriter)"/> method
- to write out the event message.
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Layout.Pattern.MethodLocationPatternConverter">
- <summary>
- Write the method name to the output
- </summary>
- <remarks>
- <para>
- Writes the caller location <see cref="P:log4net.Core.LocationInfo.MethodName"/> to
- the output.
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- </member>
- <member name="M:log4net.Layout.Pattern.MethodLocationPatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
- <summary>
- Write the method name to the output
- </summary>
- <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
- <param name="loggingEvent">the event being logged</param>
- <remarks>
- <para>
- Writes the caller location <see cref="P:log4net.Core.LocationInfo.MethodName"/> to
- the output.
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Layout.Pattern.NdcPatternConverter">
- <summary>
- Converter to include event NDC
- </summary>
- <remarks>
- <para>
- Outputs the value of the event property named <c>NDC</c>.
- </para>
- <para>
- The <see cref="T:log4net.Layout.Pattern.PropertyPatternConverter"/> should be used instead.
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- </member>
- <member name="M:log4net.Layout.Pattern.NdcPatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
- <summary>
- Write the event NDC to the output
- </summary>
- <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
- <param name="loggingEvent">the event being logged</param>
- <remarks>
- <para>
- As the thread context stacks are now stored in named event properties
- this converter simply looks up the value of the <c>NDC</c> property.
- </para>
- <para>
- The <see cref="T:log4net.Layout.Pattern.PropertyPatternConverter"/> should be used instead.
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Layout.Pattern.PropertyPatternConverter">
- <summary>
- Property pattern converter
- </summary>
- <remarks>
- <para>
- Writes out the value of a named property. The property name
- should be set in the <see cref="P:log4net.Util.PatternConverter.Option"/>
- property.
- </para>
- <para>
- If the <see cref="P:log4net.Util.PatternConverter.Option"/> is set to <c>null</c>
- then all the properties are written as key value pairs.
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- </member>
- <member name="M:log4net.Layout.Pattern.PropertyPatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
- <summary>
- Write the property value to the output
- </summary>
- <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
- <param name="loggingEvent">the event being logged</param>
- <remarks>
- <para>
- Writes out the value of a named property. The property name
- should be set in the <see cref="P:log4net.Util.PatternConverter.Option"/>
- property.
- </para>
- <para>
- If the <see cref="P:log4net.Util.PatternConverter.Option"/> is set to <c>null</c>
- then all the properties are written as key value pairs.
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Layout.Pattern.RelativeTimePatternConverter">
- <summary>
- Converter to output the relative time of the event
- </summary>
- <remarks>
- <para>
- Converter to output the time of the event relative to the start of the program.
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- </member>
- <member name="M:log4net.Layout.Pattern.RelativeTimePatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
- <summary>
- Write the relative time to the output
- </summary>
- <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
- <param name="loggingEvent">the event being logged</param>
- <remarks>
- <para>
- Writes out the relative time of the event in milliseconds.
- That is the number of milliseconds between the event <see cref="P:log4net.Core.LoggingEvent.TimeStamp"/>
- and the <see cref="P:log4net.Core.LoggingEvent.StartTime"/>.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Layout.Pattern.RelativeTimePatternConverter.TimeDifferenceInMillis(System.DateTime,System.DateTime)">
- <summary>
- Helper method to get the time difference between two DateTime objects
- </summary>
- <param name="start">start time (in the current local time zone)</param>
- <param name="end">end time (in the current local time zone)</param>
- <returns>the time difference in milliseconds</returns>
- </member>
- <member name="T:log4net.Layout.Pattern.StackTraceDetailPatternConverter">
- <summary>
- Write the caller stack frames to the output
- </summary>
- <remarks>
- <para>
- Writes the <see cref="P:log4net.Core.LocationInfo.StackFrames"/> to the output writer, using format:
- type3.MethodCall3(type param,...) > type2.MethodCall2(type param,...) > type1.MethodCall1(type param,...)
- </para>
- </remarks>
- <author>Adam Davies</author>
- </member>
- <member name="T:log4net.Layout.Pattern.StackTracePatternConverter">
- <summary>
- Write the caller stack frames to the output
- </summary>
- <remarks>
- <para>
- Writes the <see cref="P:log4net.Core.LocationInfo.StackFrames"/> to the output writer, using format:
- type3.MethodCall3 > type2.MethodCall2 > type1.MethodCall1
- </para>
- </remarks>
- <author>Michael Cromwell</author>
- </member>
- <member name="M:log4net.Layout.Pattern.StackTracePatternConverter.ActivateOptions">
- <summary>
- Initialize the converter
- </summary>
- <remarks>
- <para>
- This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
- activation scheme. The <see cref="M:log4net.Layout.Pattern.StackTracePatternConverter.ActivateOptions"/> method must
- be called on this object after the configuration properties have
- been set. Until <see cref="M:log4net.Layout.Pattern.StackTracePatternConverter.ActivateOptions"/> is called this
- object is in an undefined state and must not be used.
- </para>
- <para>
- If any of the configuration properties are modified then
- <see cref="M:log4net.Layout.Pattern.StackTracePatternConverter.ActivateOptions"/> must be called again.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Layout.Pattern.StackTracePatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
- <summary>
- Write the strack frames to the output
- </summary>
- <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
- <param name="loggingEvent">the event being logged</param>
- <remarks>
- <para>
- Writes the <see cref="P:log4net.Core.LocationInfo.StackFrames"/> to the output writer.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Layout.Pattern.StackTracePatternConverter.GetMethodInformation(log4net.Core.MethodItem)">
- <summary>
- Returns the Name of the method
- </summary>
- <param name="method"></param>
- <remarks>This method was created, so this class could be used as a base class for StackTraceDetailPatternConverter</remarks>
- <returns>string</returns>
- </member>
- <member name="F:log4net.Layout.Pattern.StackTracePatternConverter.declaringType">
- <summary>
- The fully qualified type of the StackTracePatternConverter class.
- </summary>
- <remarks>
- Used by the internal logger to record the Type of the
- log message.
- </remarks>
- </member>
- <member name="F:log4net.Layout.Pattern.StackTraceDetailPatternConverter.declaringType">
- <summary>
- The fully qualified type of the StackTraceDetailPatternConverter class.
- </summary>
- <remarks>
- Used by the internal logger to record the Type of the
- log message.
- </remarks>
- </member>
- <member name="T:log4net.Layout.Pattern.ThreadPatternConverter">
- <summary>
- Converter to include event thread name
- </summary>
- <remarks>
- <para>
- Writes the <see cref="P:log4net.Core.LoggingEvent.ThreadName"/> to the output.
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- </member>
- <member name="M:log4net.Layout.Pattern.ThreadPatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
- <summary>
- Write the ThreadName to the output
- </summary>
- <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
- <param name="loggingEvent">the event being logged</param>
- <remarks>
- <para>
- Writes the <see cref="P:log4net.Core.LoggingEvent.ThreadName"/> to the <paramref name="writer"/>.
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Layout.Pattern.TypeNamePatternConverter">
- <summary>
- Pattern converter for the class name
- </summary>
- <remarks>
- <para>
- Outputs the <see cref="P:log4net.Core.LocationInfo.ClassName"/> of the event.
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- </member>
- <member name="M:log4net.Layout.Pattern.TypeNamePatternConverter.GetFullyQualifiedName(log4net.Core.LoggingEvent)">
- <summary>
- Gets the fully qualified name of the class
- </summary>
- <param name="loggingEvent">the event being logged</param>
- <returns>The fully qualified type name for the caller location</returns>
- <remarks>
- <para>
- Returns the <see cref="P:log4net.Core.LocationInfo.ClassName"/> of the <paramref name="loggingEvent"/>.
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Layout.Pattern.UserNamePatternConverter">
- <summary>
- Converter to include event user name
- </summary>
- <author>Douglas de la Torre</author>
- <author>Nicko Cadell</author>
- </member>
- <member name="M:log4net.Layout.Pattern.UserNamePatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
- <summary>
- Convert the pattern to the rendered message
- </summary>
- <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
- <param name="loggingEvent">the event being logged</param>
- </member>
- <member name="T:log4net.Layout.Pattern.UtcDatePatternConverter">
- <summary>
- Write the TimeStamp to the output
- </summary>
- <remarks>
- <para>
- Date pattern converter, uses a <see cref="T:log4net.DateFormatter.IDateFormatter"/> to format
- the date of a <see cref="T:log4net.Core.LoggingEvent"/>.
- </para>
- <para>
- Uses a <see cref="T:log4net.DateFormatter.IDateFormatter"/> to format the <see cref="P:log4net.Core.LoggingEvent.TimeStamp"/>
- in Universal time.
- </para>
- <para>
- See the <see cref="T:log4net.Layout.Pattern.DatePatternConverter"/> for details on the date pattern syntax.
- </para>
- </remarks>
- <seealso cref="T:log4net.Layout.Pattern.DatePatternConverter"/>
- <author>Nicko Cadell</author>
- </member>
- <member name="M:log4net.Layout.Pattern.UtcDatePatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
- <summary>
- Write the TimeStamp to the output
- </summary>
- <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
- <param name="loggingEvent">the event being logged</param>
- <remarks>
- <para>
- Pass the <see cref="P:log4net.Core.LoggingEvent.TimeStamp"/> to the <see cref="T:log4net.DateFormatter.IDateFormatter"/>
- for it to render it to the writer.
- </para>
- <para>
- The <see cref="P:log4net.Core.LoggingEvent.TimeStamp"/> passed is in the local time zone, this is converted
- to Universal time before it is rendered.
- </para>
- </remarks>
- <seealso cref="T:log4net.Layout.Pattern.DatePatternConverter"/>
- </member>
- <member name="F:log4net.Layout.Pattern.UtcDatePatternConverter.declaringType">
- <summary>
- The fully qualified type of the UtcDatePatternConverter class.
- </summary>
- <remarks>
- Used by the internal logger to record the Type of the
- log message.
- </remarks>
- </member>
- <member name="T:log4net.Layout.DynamicPatternLayout">
- <summary>
- A flexible layout configurable with pattern string that re-evaluates on each call.
- </summary>
- <remarks>
- <para>This class is built on <see cref="T:log4net.Layout.PatternLayout"></see> and provides all the
- features and capabilities of PatternLayout. PatternLayout is a 'static' class
- in that its layout is done once at configuration time. This class will recreate
- the layout on each reference.</para>
- <para>One important difference between PatternLayout and DynamicPatternLayout is the
- treatment of the Header and Footer parameters in the configuration. The Header and Footer
- parameters for DynamicPatternLayout must be syntactically in the form of a PatternString,
- but should not be marked as type log4net.Util.PatternString. Doing so causes the
- pattern to be statically converted at configuration time and causes DynamicPatternLayout
- to perform the same as PatternLayout.</para>
- <para>Please see <see cref="T:log4net.Layout.PatternLayout"/> for complete documentation.</para>
- <example>
- <layout type="log4net.Layout.DynamicPatternLayout">
- <param name="Header" value="%newline**** Trace Opened Local: %date{yyyy-MM-dd HH:mm:ss.fff} UTC: %utcdate{yyyy-MM-dd HH:mm:ss.fff} ****%newline" />
- <param name="Footer" value="**** Trace Closed %date{yyyy-MM-dd HH:mm:ss.fff} ****%newline" />
- </layout>
- </example>
- </remarks>
- </member>
- <member name="T:log4net.Layout.PatternLayout">
- <summary>
- A flexible layout configurable with pattern string.
- </summary>
- <remarks>
- <para>
- The goal of this class is to <see cref="M:PatternLayout.Format(TextWriter,LoggingEvent)"/> a
- <see cref="T:log4net.Core.LoggingEvent"/> as a string. The results
- depend on the <i>conversion pattern</i>.
- </para>
- <para>
- The conversion pattern is closely related to the conversion
- pattern of the printf function in C. A conversion pattern is
- composed of literal text and format control expressions called
- <i>conversion specifiers</i>.
- </para>
- <para>
- <i>You are free to insert any literal text within the conversion
- pattern.</i>
- </para>
- <para>
- Each conversion specifier starts with a percent sign (%) and is
- followed by optional <i>format modifiers</i> and a <i>conversion
- pattern name</i>. The conversion pattern name specifies the type of
- data, e.g. logger, level, date, thread name. The format
- modifiers control such things as field width, padding, left and
- right justification. The following is a simple example.
- </para>
- <para>
- Let the conversion pattern be <b>"%-5level [%thread]: %message%newline"</b> and assume
- that the log4net environment was set to use a PatternLayout. Then the
- statements
- </para>
- <code lang="C#">
- ILog log = LogManager.GetLogger(typeof(TestApp));
- log.Debug("Message 1");
- log.Warn("Message 2");
- </code>
- <para>would yield the output</para>
- <code>
- DEBUG [main]: Message 1
- WARN [main]: Message 2
- </code>
- <para>
- Note that there is no explicit separator between text and
- conversion specifiers. The pattern parser knows when it has reached
- the end of a conversion specifier when it reads a conversion
- character. In the example above the conversion specifier
- <b>%-5level</b> means the level of the logging event should be left
- justified to a width of five characters.
- </para>
- <para>
- The recognized conversion pattern names are:
- </para>
- <list type="table">
- <listheader>
- <term>Conversion Pattern Name</term>
- <description>Effect</description>
- </listheader>
- <item>
- <term>a</term>
- <description>Equivalent to <b>appdomain</b></description>
- </item>
- <item>
- <term>appdomain</term>
- <description>
- Used to output the friendly name of the AppDomain where the
- logging event was generated.
- </description>
- </item>
- <item>
- <term>aspnet-cache</term>
- <description>
- <para>
- Used to output all cache items in the case of <b>%aspnet-cache</b> or just one named item if used as <b>%aspnet-cache{key}</b>
- </para>
- <para>
- This pattern is not available for Compact Framework or Client Profile assemblies.
- </para>
- </description>
- </item>
- <item>
- <term>aspnet-context</term>
- <description>
- <para>
- Used to output all context items in the case of <b>%aspnet-context</b> or just one named item if used as <b>%aspnet-context{key}</b>
- </para>
- <para>
- This pattern is not available for Compact Framework or Client Profile assemblies.
- </para>
- </description>
- </item>
- <item>
- <term>aspnet-request</term>
- <description>
- <para>
- Used to output all request parameters in the case of <b>%aspnet-request</b> or just one named param if used as <b>%aspnet-request{key}</b>
- </para>
- <para>
- This pattern is not available for Compact Framework or Client Profile assemblies.
- </para>
- </description>
- </item>
- <item>
- <term>aspnet-session</term>
- <description>
- <para>
- Used to output all session items in the case of <b>%aspnet-session</b> or just one named item if used as <b>%aspnet-session{key}</b>
- </para>
- <para>
- This pattern is not available for Compact Framework or Client Profile assemblies.
- </para>
- </description>
- </item>
- <item>
- <term>c</term>
- <description>Equivalent to <b>logger</b></description>
- </item>
- <item>
- <term>C</term>
- <description>Equivalent to <b>type</b></description>
- </item>
- <item>
- <term>class</term>
- <description>Equivalent to <b>type</b></description>
- </item>
- <item>
- <term>d</term>
- <description>Equivalent to <b>date</b></description>
- </item>
- <item>
- <term>date</term>
- <description>
- <para>
- Used to output the date of the logging event in the local time zone.
- To output the date in universal time use the <c>%utcdate</c> pattern.
- The date conversion
- specifier may be followed by a <i>date format specifier</i> enclosed
- between braces. For example, <b>%date{HH:mm:ss,fff}</b> or
- <b>%date{dd MMM yyyy HH:mm:ss,fff}</b>. If no date format specifier is
- given then ISO8601 format is
- assumed (<see cref="T:log4net.DateFormatter.Iso8601DateFormatter"/>).
- </para>
- <para>
- The date format specifier admits the same syntax as the
- time pattern string of the <see cref="M:DateTime.ToString(string)"/>.
- </para>
- <para>
- For better results it is recommended to use the log4net date
- formatters. These can be specified using one of the strings
- "ABSOLUTE", "DATE" and "ISO8601" for specifying
- <see cref="T:log4net.DateFormatter.AbsoluteTimeDateFormatter"/>,
- <see cref="T:log4net.DateFormatter.DateTimeDateFormatter"/> and respectively
- <see cref="T:log4net.DateFormatter.Iso8601DateFormatter"/>. For example,
- <b>%date{ISO8601}</b> or <b>%date{ABSOLUTE}</b>.
- </para>
- <para>
- These dedicated date formatters perform significantly
- better than <see cref="M:DateTime.ToString(string)"/>.
- </para>
- </description>
- </item>
- <item>
- <term>exception</term>
- <description>
- <para>
- Used to output the exception passed in with the log message.
- </para>
- <para>
- If an exception object is stored in the logging event
- it will be rendered into the pattern output with a
- trailing newline.
- If there is no exception then nothing will be output
- and no trailing newline will be appended.
- It is typical to put a newline before the exception
- and to have the exception as the last data in the pattern.
- </para>
- </description>
- </item>
- <item>
- <term>F</term>
- <description>Equivalent to <b>file</b></description>
- </item>
- <item>
- <term>file</term>
- <description>
- <para>
- Used to output the file name where the logging request was
- issued.
- </para>
- <para>
- <b>WARNING</b> Generating caller location information is
- extremely slow. Its use should be avoided unless execution speed
- is not an issue.
- </para>
- <para>
- See the note below on the availability of caller location information.
- </para>
- </description>
- </item>
- <item>
- <term>identity</term>
- <description>
- <para>
- Used to output the user name for the currently active user
- (Principal.Identity.Name).
- </para>
- <para>
- <b>WARNING</b> Generating caller information is
- extremely slow. Its use should be avoided unless execution speed
- is not an issue.
- </para>
- </description>
- </item>
- <item>
- <term>l</term>
- <description>Equivalent to <b>location</b></description>
- </item>
- <item>
- <term>L</term>
- <description>Equivalent to <b>line</b></description>
- </item>
- <item>
- <term>location</term>
- <description>
- <para>
- Used to output location information of the caller which generated
- the logging event.
- </para>
- <para>
- The location information depends on the CLI implementation but
- usually consists of the fully qualified name of the calling
- method followed by the callers source the file name and line
- number between parentheses.
- </para>
- <para>
- The location information can be very useful. However, its
- generation is <b>extremely</b> slow. Its use should be avoided
- unless execution speed is not an issue.
- </para>
- <para>
- See the note below on the availability of caller location information.
- </para>
- </description>
- </item>
- <item>
- <term>level</term>
- <description>
- <para>
- Used to output the level of the logging event.
- </para>
- </description>
- </item>
- <item>
- <term>line</term>
- <description>
- <para>
- Used to output the line number from where the logging request
- was issued.
- </para>
- <para>
- <b>WARNING</b> Generating caller location information is
- extremely slow. Its use should be avoided unless execution speed
- is not an issue.
- </para>
- <para>
- See the note below on the availability of caller location information.
- </para>
- </description>
- </item>
- <item>
- <term>logger</term>
- <description>
- <para>
- Used to output the logger of the logging event. The
- logger conversion specifier can be optionally followed by
- <i>precision specifier</i>, that is a decimal constant in
- brackets.
- </para>
- <para>
- If a precision specifier is given, then only the corresponding
- number of right most components of the logger name will be
- printed. By default the logger name is printed in full.
- </para>
- <para>
- For example, for the logger name "a.b.c" the pattern
- <b>%logger{2}</b> will output "b.c".
- </para>
- </description>
- </item>
- <item>
- <term>m</term>
- <description>Equivalent to <b>message</b></description>
- </item>
- <item>
- <term>M</term>
- <description>Equivalent to <b>method</b></description>
- </item>
- <item>
- <term>message</term>
- <description>
- <para>
- Used to output the application supplied message associated with
- the logging event.
- </para>
- </description>
- </item>
- <item>
- <term>mdc</term>
- <description>
- <para>
- The MDC (old name for the ThreadContext.Properties) is now part of the
- combined event properties. This pattern is supported for compatibility
- but is equivalent to <b>property</b>.
- </para>
- </description>
- </item>
- <item>
- <term>method</term>
- <description>
- <para>
- Used to output the method name where the logging request was
- issued.
- </para>
- <para>
- <b>WARNING</b> Generating caller location information is
- extremely slow. Its use should be avoided unless execution speed
- is not an issue.
- </para>
- <para>
- See the note below on the availability of caller location information.
- </para>
- </description>
- </item>
- <item>
- <term>n</term>
- <description>Equivalent to <b>newline</b></description>
- </item>
- <item>
- <term>newline</term>
- <description>
- <para>
- Outputs the platform dependent line separator character or
- characters.
- </para>
- <para>
- This conversion pattern offers the same performance as using
- non-portable line separator strings such as "\n", or "\r\n".
- Thus, it is the preferred way of specifying a line separator.
- </para>
- </description>
- </item>
- <item>
- <term>ndc</term>
- <description>
- <para>
- Used to output the NDC (nested diagnostic context) associated
- with the thread that generated the logging event.
- </para>
- </description>
- </item>
- <item>
- <term>p</term>
- <description>Equivalent to <b>level</b></description>
- </item>
- <item>
- <term>P</term>
- <description>Equivalent to <b>property</b></description>
- </item>
- <item>
- <term>properties</term>
- <description>Equivalent to <b>property</b></description>
- </item>
- <item>
- <term>property</term>
- <description>
- <para>
- Used to output the an event specific property. The key to
- lookup must be specified within braces and directly following the
- pattern specifier, e.g. <b>%property{user}</b> would include the value
- from the property that is keyed by the string 'user'. Each property value
- that is to be included in the log must be specified separately.
- Properties are added to events by loggers or appenders. By default
- the <c>log4net:HostName</c> property is set to the name of machine on
- which the event was originally logged.
- </para>
- <para>
- If no key is specified, e.g. <b>%property</b> then all the keys and their
- values are printed in a comma separated list.
- </para>
- <para>
- The properties of an event are combined from a number of different
- contexts. These are listed below in the order in which they are searched.
- </para>
- <list type="definition">
- <item>
- <term>the event properties</term>
- <description>
- The event has <see cref="P:log4net.Core.LoggingEvent.Properties"/> that can be set. These
- properties are specific to this event only.
- </description>
- </item>
- <item>
- <term>the thread properties</term>
- <description>
- The <see cref="P:log4net.ThreadContext.Properties"/> that are set on the current
- thread. These properties are shared by all events logged on this thread.
- </description>
- </item>
- <item>
- <term>the global properties</term>
- <description>
- The <see cref="P:log4net.GlobalContext.Properties"/> that are set globally. These
- properties are shared by all the threads in the AppDomain.
- </description>
- </item>
- </list>
-
- </description>
- </item>
- <item>
- <term>r</term>
- <description>Equivalent to <b>timestamp</b></description>
- </item>
- <item>
- <term>stacktrace</term>
- <description>
- <para>
- Used to output the stack trace of the logging event
- The stack trace level specifier may be enclosed
- between braces. For example, <b>%stacktrace{level}</b>.
- If no stack trace level specifier is given then 1 is assumed
- </para>
- <para>
- Output uses the format:
- type3.MethodCall3 > type2.MethodCall2 > type1.MethodCall1
- </para>
- <para>
- This pattern is not available for Compact Framework assemblies.
- </para>
- </description>
- </item>
- <item>
- <term>stacktracedetail</term>
- <description>
- <para>
- Used to output the stack trace of the logging event
- The stack trace level specifier may be enclosed
- between braces. For example, <b>%stacktracedetail{level}</b>.
- If no stack trace level specifier is given then 1 is assumed
- </para>
- <para>
- Output uses the format:
- type3.MethodCall3(type param,...) > type2.MethodCall2(type param,...) > type1.MethodCall1(type param,...)
- </para>
- <para>
- This pattern is not available for Compact Framework assemblies.
- </para>
- </description>
- </item>
- <item>
- <term>t</term>
- <description>Equivalent to <b>thread</b></description>
- </item>
- <item>
- <term>timestamp</term>
- <description>
- <para>
- Used to output the number of milliseconds elapsed since the start
- of the application until the creation of the logging event.
- </para>
- </description>
- </item>
- <item>
- <term>thread</term>
- <description>
- <para>
- Used to output the name of the thread that generated the
- logging event. Uses the thread number if no name is available.
- </para>
- </description>
- </item>
- <item>
- <term>type</term>
- <description>
- <para>
- Used to output the fully qualified type name of the caller
- issuing the logging request. This conversion specifier
- can be optionally followed by <i>precision specifier</i>, that
- is a decimal constant in brackets.
- </para>
- <para>
- If a precision specifier is given, then only the corresponding
- number of right most components of the class name will be
- printed. By default the class name is output in fully qualified form.
- </para>
- <para>
- For example, for the class name "log4net.Layout.PatternLayout", the
- pattern <b>%type{1}</b> will output "PatternLayout".
- </para>
- <para>
- <b>WARNING</b> Generating the caller class information is
- slow. Thus, its use should be avoided unless execution speed is
- not an issue.
- </para>
- <para>
- See the note below on the availability of caller location information.
- </para>
- </description>
- </item>
- <item>
- <term>u</term>
- <description>Equivalent to <b>identity</b></description>
- </item>
- <item>
- <term>username</term>
- <description>
- <para>
- Used to output the WindowsIdentity for the currently
- active user.
- </para>
- <para>
- <b>WARNING</b> Generating caller WindowsIdentity information is
- extremely slow. Its use should be avoided unless execution speed
- is not an issue.
- </para>
- </description>
- </item>
- <item>
- <term>utcdate</term>
- <description>
- <para>
- Used to output the date of the logging event in universal time.
- The date conversion
- specifier may be followed by a <i>date format specifier</i> enclosed
- between braces. For example, <b>%utcdate{HH:mm:ss,fff}</b> or
- <b>%utcdate{dd MMM yyyy HH:mm:ss,fff}</b>. If no date format specifier is
- given then ISO8601 format is
- assumed (<see cref="T:log4net.DateFormatter.Iso8601DateFormatter"/>).
- </para>
- <para>
- The date format specifier admits the same syntax as the
- time pattern string of the <see cref="M:DateTime.ToString(string)"/>.
- </para>
- <para>
- For better results it is recommended to use the log4net date
- formatters. These can be specified using one of the strings
- "ABSOLUTE", "DATE" and "ISO8601" for specifying
- <see cref="T:log4net.DateFormatter.AbsoluteTimeDateFormatter"/>,
- <see cref="T:log4net.DateFormatter.DateTimeDateFormatter"/> and respectively
- <see cref="T:log4net.DateFormatter.Iso8601DateFormatter"/>. For example,
- <b>%utcdate{ISO8601}</b> or <b>%utcdate{ABSOLUTE}</b>.
- </para>
- <para>
- These dedicated date formatters perform significantly
- better than <see cref="M:DateTime.ToString(string)"/>.
- </para>
- </description>
- </item>
- <item>
- <term>w</term>
- <description>Equivalent to <b>username</b></description>
- </item>
- <item>
- <term>x</term>
- <description>Equivalent to <b>ndc</b></description>
- </item>
- <item>
- <term>X</term>
- <description>Equivalent to <b>mdc</b></description>
- </item>
- <item>
- <term>%</term>
- <description>
- <para>
- The sequence %% outputs a single percent sign.
- </para>
- </description>
- </item>
- </list>
- <para>
- The single letter patterns are deprecated in favor of the
- longer more descriptive pattern names.
- </para>
- <para>
- By default the relevant information is output as is. However,
- with the aid of format modifiers it is possible to change the
- minimum field width, the maximum field width and justification.
- </para>
- <para>
- The optional format modifier is placed between the percent sign
- and the conversion pattern name.
- </para>
- <para>
- The first optional format modifier is the <i>left justification
- flag</i> which is just the minus (-) character. Then comes the
- optional <i>minimum field width</i> modifier. This is a decimal
- constant that represents the minimum number of characters to
- output. If the data item requires fewer characters, it is padded on
- either the left or the right until the minimum width is
- reached. The default is to pad on the left (right justify) but you
- can specify right padding with the left justification flag. The
- padding character is space. If the data item is larger than the
- minimum field width, the field is expanded to accommodate the
- data. The value is never truncated.
- </para>
- <para>
- This behavior can be changed using the <i>maximum field
- width</i> modifier which is designated by a period followed by a
- decimal constant. If the data item is longer than the maximum
- field, then the extra characters are removed from the
- <i>beginning</i> of the data item and not from the end. For
- example, it the maximum field width is eight and the data item is
- ten characters long, then the first two characters of the data item
- are dropped. This behavior deviates from the printf function in C
- where truncation is done from the end.
- </para>
- <para>
- Below are various format modifier examples for the logger
- conversion specifier.
- </para>
- <div class="tablediv">
- <table class="dtTABLE" cellspacing="0">
- <tr>
- <th>Format modifier</th>
- <th>left justify</th>
- <th>minimum width</th>
- <th>maximum width</th>
- <th>comment</th>
- </tr>
- <tr>
- <td align="center">%20logger</td>
- <td align="center">false</td>
- <td align="center">20</td>
- <td align="center">none</td>
- <td>
- <para>
- Left pad with spaces if the logger name is less than 20
- characters long.
- </para>
- </td>
- </tr>
- <tr>
- <td align="center">%-20logger</td>
- <td align="center">true</td>
- <td align="center">20</td>
- <td align="center">none</td>
- <td>
- <para>
- Right pad with spaces if the logger
- name is less than 20 characters long.
- </para>
- </td>
- </tr>
- <tr>
- <td align="center">%.30logger</td>
- <td align="center">NA</td>
- <td align="center">none</td>
- <td align="center">30</td>
- <td>
- <para>
- Truncate from the beginning if the logger
- name is longer than 30 characters.
- </para>
- </td>
- </tr>
- <tr>
- <td align="center"><nobr>%20.30logger</nobr></td>
- <td align="center">false</td>
- <td align="center">20</td>
- <td align="center">30</td>
- <td>
- <para>
- Left pad with spaces if the logger name is shorter than 20
- characters. However, if logger name is longer than 30 characters,
- then truncate from the beginning.
- </para>
- </td>
- </tr>
- <tr>
- <td align="center">%-20.30logger</td>
- <td align="center">true</td>
- <td align="center">20</td>
- <td align="center">30</td>
- <td>
- <para>
- Right pad with spaces if the logger name is shorter than 20
- characters. However, if logger name is longer than 30 characters,
- then truncate from the beginning.
- </para>
- </td>
- </tr>
- </table>
- </div>
- <para>
- <b>Note about caller location information.</b><br/>
- The following patterns <c>%type %file %line %method %location %class %C %F %L %l %M</c>
- all generate caller location information.
- Location information uses the <c>System.Diagnostics.StackTrace</c> class to generate
- a call stack. The caller's information is then extracted from this stack.
- </para>
- <note type="caution">
- <para>
- The <c>System.Diagnostics.StackTrace</c> class is not supported on the
- .NET Compact Framework 1.0 therefore caller location information is not
- available on that framework.
- </para>
- </note>
- <note type="caution">
- <para>
- The <c>System.Diagnostics.StackTrace</c> class has this to say about Release builds:
- </para>
- <para>
- "StackTrace information will be most informative with Debug build configurations.
- By default, Debug builds include debug symbols, while Release builds do not. The
- debug symbols contain most of the file, method name, line number, and column
- information used in constructing StackFrame and StackTrace objects. StackTrace
- might not report as many method calls as expected, due to code transformations
- that occur during optimization."
- </para>
- <para>
- This means that in a Release build the caller information may be incomplete or may
- not exist at all! Therefore caller location information cannot be relied upon in a Release build.
- </para>
- </note>
- <para>
- Additional pattern converters may be registered with a specific <see cref="T:log4net.Layout.PatternLayout"/>
- instance using the <see cref="M:AddConverter(string, Type)"/> method.
- </para>
- </remarks>
- <example>
- This is a more detailed pattern.
- <code><b>%timestamp [%thread] %level %logger %ndc - %message%newline</b></code>
- </example>
- <example>
- A similar pattern except that the relative time is
- right padded if less than 6 digits, thread name is right padded if
- less than 15 characters and truncated if longer and the logger
- name is left padded if shorter than 30 characters and truncated if
- longer.
- <code><b>%-6timestamp [%15.15thread] %-5level %30.30logger %ndc - %message%newline</b></code>
- </example>
- <author>Nicko Cadell</author>
- <author>Gert Driesen</author>
- <author>Douglas de la Torre</author>
- <author>Daniel Cazzulino</author>
- </member>
- <member name="T:log4net.Layout.LayoutSkeleton">
- <summary>
- Extend this abstract class to create your own log layout format.
- </summary>
- <remarks>
- <para>
- This is the base implementation of the <see cref="T:log4net.Layout.ILayout"/>
- interface. Most layout objects should extend this class.
- </para>
- </remarks>
- <remarks>
- <note type="inheritinfo">
- <para>
- Subclasses must implement the <see cref="M:Format(TextWriter,LoggingEvent)"/>
- method.
- </para>
- <para>
- Subclasses should set the <see cref="P:log4net.Layout.LayoutSkeleton.IgnoresException"/> in their default
- constructor.
- </para>
- </note>
- </remarks>
- <author>Nicko Cadell</author>
- <author>Gert Driesen</author>
- </member>
- <member name="T:log4net.Layout.ILayout">
- <summary>
- Interface implemented by layout objects
- </summary>
- <remarks>
- <para>
- An <see cref="T:log4net.Layout.ILayout"/> object is used to format a <see cref="T:log4net.Core.LoggingEvent"/>
- as text. The <see cref="M:Format(TextWriter,LoggingEvent)"/> method is called by an
- appender to transform the <see cref="T:log4net.Core.LoggingEvent"/> into a string.
- </para>
- <para>
- The layout can also supply <see cref="P:log4net.Layout.ILayout.Header"/> and <see cref="P:log4net.Layout.ILayout.Footer"/>
- text that is appender before any events and after all the events respectively.
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- <author>Gert Driesen</author>
- </member>
- <member name="M:log4net.Layout.ILayout.Format(System.IO.TextWriter,log4net.Core.LoggingEvent)">
- <summary>
- Implement this method to create your own layout format.
- </summary>
- <param name="writer">The TextWriter to write the formatted event to</param>
- <param name="loggingEvent">The event to format</param>
- <remarks>
- <para>
- This method is called by an appender to format
- the <paramref name="loggingEvent"/> as text and output to a writer.
- </para>
- <para>
- If the caller does not have a <see cref="T:System.IO.TextWriter"/> and prefers the
- event to be formatted as a <see cref="T:System.String"/> then the following
- code can be used to format the event into a <see cref="T:System.IO.StringWriter"/>.
- </para>
- <code lang="C#">
- StringWriter writer = new StringWriter();
- Layout.Format(writer, loggingEvent);
- string formattedEvent = writer.ToString();
- </code>
- </remarks>
- </member>
- <member name="P:log4net.Layout.ILayout.ContentType">
- <summary>
- The content type output by this layout.
- </summary>
- <value>The content type</value>
- <remarks>
- <para>
- The content type output by this layout.
- </para>
- <para>
- This is a MIME type e.g. <c>"text/plain"</c>.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Layout.ILayout.Header">
- <summary>
- The header for the layout format.
- </summary>
- <value>the layout header</value>
- <remarks>
- <para>
- The Header text will be appended before any logging events
- are formatted and appended.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Layout.ILayout.Footer">
- <summary>
- The footer for the layout format.
- </summary>
- <value>the layout footer</value>
- <remarks>
- <para>
- The Footer text will be appended after all the logging events
- have been formatted and appended.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Layout.ILayout.IgnoresException">
- <summary>
- Flag indicating if this layout handle exceptions
- </summary>
- <value><c>false</c> if this layout handles exceptions</value>
- <remarks>
- <para>
- If this layout handles the exception object contained within
- <see cref="T:log4net.Core.LoggingEvent"/>, then the layout should return
- <c>false</c>. Otherwise, if the layout ignores the exception
- object, then the layout should return <c>true</c>.
- </para>
- </remarks>
- </member>
- <member name="F:log4net.Layout.LayoutSkeleton.m_header">
- <summary>
- The header text
- </summary>
- <remarks>
- <para>
- See <see cref="P:log4net.Layout.LayoutSkeleton.Header"/> for more information.
- </para>
- </remarks>
- </member>
- <member name="F:log4net.Layout.LayoutSkeleton.m_footer">
- <summary>
- The footer text
- </summary>
- <remarks>
- <para>
- See <see cref="P:log4net.Layout.LayoutSkeleton.Footer"/> for more information.
- </para>
- </remarks>
- </member>
- <member name="F:log4net.Layout.LayoutSkeleton.m_ignoresException">
- <summary>
- Flag indicating if this layout handles exceptions
- </summary>
- <remarks>
- <para>
- <c>false</c> if this layout handles exceptions
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Layout.LayoutSkeleton.#ctor">
- <summary>
- Empty default constructor
- </summary>
- <remarks>
- <para>
- Empty default constructor
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Layout.LayoutSkeleton.ActivateOptions">
- <summary>
- Activate component options
- </summary>
- <remarks>
- <para>
- This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
- activation scheme. The <see cref="M:log4net.Layout.LayoutSkeleton.ActivateOptions"/> method must
- be called on this object after the configuration properties have
- been set. Until <see cref="M:log4net.Layout.LayoutSkeleton.ActivateOptions"/> is called this
- object is in an undefined state and must not be used.
- </para>
- <para>
- If any of the configuration properties are modified then
- <see cref="M:log4net.Layout.LayoutSkeleton.ActivateOptions"/> must be called again.
- </para>
- <para>
- This method must be implemented by the subclass.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Layout.LayoutSkeleton.Format(System.IO.TextWriter,log4net.Core.LoggingEvent)">
- <summary>
- Implement this method to create your own layout format.
- </summary>
- <param name="writer">The TextWriter to write the formatted event to</param>
- <param name="loggingEvent">The event to format</param>
- <remarks>
- <para>
- This method is called by an appender to format
- the <paramref name="loggingEvent"/> as text.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Layout.LayoutSkeleton.Format(log4net.Core.LoggingEvent)">
- <summary>
- Convenience method for easily formatting the logging event into a string variable.
- </summary>
- <param name="loggingEvent"></param>
- <remarks>
- Creates a new StringWriter instance to store the formatted logging event.
- </remarks>
- </member>
- <member name="P:log4net.Layout.LayoutSkeleton.ContentType">
- <summary>
- The content type output by this layout.
- </summary>
- <value>The content type is <c>"text/plain"</c></value>
- <remarks>
- <para>
- The content type output by this layout.
- </para>
- <para>
- This base class uses the value <c>"text/plain"</c>.
- To change this value a subclass must override this
- property.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Layout.LayoutSkeleton.Header">
- <summary>
- The header for the layout format.
- </summary>
- <value>the layout header</value>
- <remarks>
- <para>
- The Header text will be appended before any logging events
- are formatted and appended.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Layout.LayoutSkeleton.Footer">
- <summary>
- The footer for the layout format.
- </summary>
- <value>the layout footer</value>
- <remarks>
- <para>
- The Footer text will be appended after all the logging events
- have been formatted and appended.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Layout.LayoutSkeleton.IgnoresException">
- <summary>
- Flag indicating if this layout handles exceptions
- </summary>
- <value><c>false</c> if this layout handles exceptions</value>
- <remarks>
- <para>
- If this layout handles the exception object contained within
- <see cref="T:log4net.Core.LoggingEvent"/>, then the layout should return
- <c>false</c>. Otherwise, if the layout ignores the exception
- object, then the layout should return <c>true</c>.
- </para>
- <para>
- Set this value to override a this default setting. The default
- value is <c>true</c>, this layout does not handle the exception.
- </para>
- </remarks>
- </member>
- <member name="F:log4net.Layout.PatternLayout.DefaultConversionPattern">
- <summary>
- Default pattern string for log output.
- </summary>
- <remarks>
- <para>
- Default pattern string for log output.
- Currently set to the string <b>"%message%newline"</b>
- which just prints the application supplied message.
- </para>
- </remarks>
- </member>
- <member name="F:log4net.Layout.PatternLayout.DetailConversionPattern">
- <summary>
- A detailed conversion pattern
- </summary>
- <remarks>
- <para>
- A conversion pattern which includes Time, Thread, Logger, and Nested Context.
- Current value is <b>%timestamp [%thread] %level %logger %ndc - %message%newline</b>.
- </para>
- </remarks>
- </member>
- <member name="F:log4net.Layout.PatternLayout.s_globalRulesRegistry">
- <summary>
- Internal map of converter identifiers to converter types.
- </summary>
- <remarks>
- <para>
- This static map is overridden by the m_converterRegistry instance map
- </para>
- </remarks>
- </member>
- <member name="F:log4net.Layout.PatternLayout.m_pattern">
- <summary>
- the pattern
- </summary>
- </member>
- <member name="F:log4net.Layout.PatternLayout.m_head">
- <summary>
- the head of the pattern converter chain
- </summary>
- </member>
- <member name="F:log4net.Layout.PatternLayout.m_instanceRulesRegistry">
- <summary>
- patterns defined on this PatternLayout only
- </summary>
- </member>
- <member name="M:log4net.Layout.PatternLayout.#cctor">
- <summary>
- Initialize the global registry
- </summary>
- <remarks>
- <para>
- Defines the builtin global rules.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Layout.PatternLayout.#ctor">
- <summary>
- Constructs a PatternLayout using the DefaultConversionPattern
- </summary>
- <remarks>
- <para>
- The default pattern just produces the application supplied message.
- </para>
- <para>
- Note to Inheritors: This constructor calls the virtual method
- <see cref="M:log4net.Layout.PatternLayout.CreatePatternParser(System.String)"/>. If you override this method be
- aware that it will be called before your is called constructor.
- </para>
- <para>
- As per the <see cref="T:log4net.Core.IOptionHandler"/> contract the <see cref="M:log4net.Layout.PatternLayout.ActivateOptions"/>
- method must be called after the properties on this object have been
- configured.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Layout.PatternLayout.#ctor(System.String)">
- <summary>
- Constructs a PatternLayout using the supplied conversion pattern
- </summary>
- <param name="pattern">the pattern to use</param>
- <remarks>
- <para>
- Note to Inheritors: This constructor calls the virtual method
- <see cref="M:log4net.Layout.PatternLayout.CreatePatternParser(System.String)"/>. If you override this method be
- aware that it will be called before your is called constructor.
- </para>
- <para>
- When using this constructor the <see cref="M:log4net.Layout.PatternLayout.ActivateOptions"/> method
- need not be called. This may not be the case when using a subclass.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Layout.PatternLayout.CreatePatternParser(System.String)">
- <summary>
- Create the pattern parser instance
- </summary>
- <param name="pattern">the pattern to parse</param>
- <returns>The <see cref="T:log4net.Util.PatternParser"/> that will format the event</returns>
- <remarks>
- <para>
- Creates the <see cref="T:log4net.Util.PatternParser"/> used to parse the conversion string. Sets the
- global and instance rules on the <see cref="T:log4net.Util.PatternParser"/>.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Layout.PatternLayout.ActivateOptions">
- <summary>
- Initialize layout options
- </summary>
- <remarks>
- <para>
- This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
- activation scheme. The <see cref="M:log4net.Layout.PatternLayout.ActivateOptions"/> method must
- be called on this object after the configuration properties have
- been set. Until <see cref="M:log4net.Layout.PatternLayout.ActivateOptions"/> is called this
- object is in an undefined state and must not be used.
- </para>
- <para>
- If any of the configuration properties are modified then
- <see cref="M:log4net.Layout.PatternLayout.ActivateOptions"/> must be called again.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Layout.PatternLayout.Format(System.IO.TextWriter,log4net.Core.LoggingEvent)">
- <summary>
- Produces a formatted string as specified by the conversion pattern.
- </summary>
- <param name="loggingEvent">the event being logged</param>
- <param name="writer">The TextWriter to write the formatted event to</param>
- <remarks>
- <para>
- Parse the <see cref="T:log4net.Core.LoggingEvent"/> using the patter format
- specified in the <see cref="P:log4net.Layout.PatternLayout.ConversionPattern"/> property.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Layout.PatternLayout.AddConverter(log4net.Util.ConverterInfo)">
- <summary>
- Add a converter to this PatternLayout
- </summary>
- <param name="converterInfo">the converter info</param>
- <remarks>
- <para>
- This version of the method is used by the configurator.
- Programmatic users should use the alternative <see cref="M:AddConverter(string,Type)"/> method.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Layout.PatternLayout.AddConverter(System.String,System.Type)">
- <summary>
- Add a converter to this PatternLayout
- </summary>
- <param name="name">the name of the conversion pattern for this converter</param>
- <param name="type">the type of the converter</param>
- <remarks>
- <para>
- Add a named pattern converter to this instance. This
- converter will be used in the formatting of the event.
- This method must be called before <see cref="M:log4net.Layout.PatternLayout.ActivateOptions"/>.
- </para>
- <para>
- The <paramref name="type"/> specified must extend the
- <see cref="T:log4net.Util.PatternConverter"/> type.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Layout.PatternLayout.ConversionPattern">
- <summary>
- The pattern formatting string
- </summary>
- <remarks>
- <para>
- The <b>ConversionPattern</b> option. This is the string which
- controls formatting and consists of a mix of literal content and
- conversion specifiers.
- </para>
- </remarks>
- </member>
- <member name="F:log4net.Layout.DynamicPatternLayout.m_headerPatternString">
- <summary>
- The header PatternString
- </summary>
- </member>
- <member name="F:log4net.Layout.DynamicPatternLayout.m_footerPatternString">
- <summary>
- The footer PatternString
- </summary>
- </member>
- <member name="M:log4net.Layout.DynamicPatternLayout.#ctor">
- <summary>
- Constructs a DynamicPatternLayout using the DefaultConversionPattern
- </summary>
- <remarks>
- <para>
- The default pattern just produces the application supplied message.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Layout.DynamicPatternLayout.#ctor(System.String)">
- <summary>
- Constructs a DynamicPatternLayout using the supplied conversion pattern
- </summary>
- <param name="pattern">the pattern to use</param>
- <remarks>
- </remarks>
- </member>
- <member name="P:log4net.Layout.DynamicPatternLayout.Header">
- <summary>
- The header for the layout format.
- </summary>
- <value>the layout header</value>
- <remarks>
- <para>
- The Header text will be appended before any logging events
- are formatted and appended.
- </para>
- The pattern will be formatted on each get operation.
- </remarks>
- </member>
- <member name="P:log4net.Layout.DynamicPatternLayout.Footer">
- <summary>
- The footer for the layout format.
- </summary>
- <value>the layout footer</value>
- <remarks>
- <para>
- The Footer text will be appended after all the logging events
- have been formatted and appended.
- </para>
- The pattern will be formatted on each get operation.
- </remarks>
- </member>
- <member name="T:log4net.Layout.ExceptionLayout">
- <summary>
- A Layout that renders only the Exception text from the logging event
- </summary>
- <remarks>
- <para>
- A Layout that renders only the Exception text from the logging event.
- </para>
- <para>
- This Layout should only be used with appenders that utilize multiple
- layouts (e.g. <see cref="T:log4net.Appender.AdoNetAppender"/>).
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- <author>Gert Driesen</author>
- </member>
- <member name="M:log4net.Layout.ExceptionLayout.#ctor">
- <summary>
- Default constructor
- </summary>
- <remarks>
- <para>
- Constructs a ExceptionLayout
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Layout.ExceptionLayout.ActivateOptions">
- <summary>
- Activate component options
- </summary>
- <remarks>
- <para>
- Part of the <see cref="T:log4net.Core.IOptionHandler"/> component activation
- framework.
- </para>
- <para>
- This method does nothing as options become effective immediately.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Layout.ExceptionLayout.Format(System.IO.TextWriter,log4net.Core.LoggingEvent)">
- <summary>
- Gets the exception text from the logging event
- </summary>
- <param name="writer">The TextWriter to write the formatted event to</param>
- <param name="loggingEvent">the event being logged</param>
- <remarks>
- <para>
- Write the exception string to the <see cref="T:System.IO.TextWriter"/>.
- The exception string is retrieved from <see cref="M:LoggingEvent.GetExceptionString()"/>.
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Layout.IRawLayout">
- <summary>
- Interface for raw layout objects
- </summary>
- <remarks>
- <para>
- Interface used to format a <see cref="T:log4net.Core.LoggingEvent"/>
- to an object.
- </para>
- <para>
- This interface should not be confused with the
- <see cref="T:log4net.Layout.ILayout"/> interface. This interface is used in
- only certain specialized situations where a raw object is
- required rather than a formatted string. The <see cref="T:log4net.Layout.ILayout"/>
- is not generally useful than this interface.
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- <author>Gert Driesen</author>
- </member>
- <member name="M:log4net.Layout.IRawLayout.Format(log4net.Core.LoggingEvent)">
- <summary>
- Implement this method to create your own layout format.
- </summary>
- <param name="loggingEvent">The event to format</param>
- <returns>returns the formatted event</returns>
- <remarks>
- <para>
- Implement this method to create your own layout format.
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Layout.Layout2RawLayoutAdapter">
- <summary>
- Adapts any <see cref="T:log4net.Layout.ILayout"/> to a <see cref="T:log4net.Layout.IRawLayout"/>
- </summary>
- <remarks>
- <para>
- Where an <see cref="T:log4net.Layout.IRawLayout"/> is required this adapter
- allows a <see cref="T:log4net.Layout.ILayout"/> to be specified.
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- <author>Gert Driesen</author>
- </member>
- <member name="F:log4net.Layout.Layout2RawLayoutAdapter.m_layout">
- <summary>
- The layout to adapt
- </summary>
- </member>
- <member name="M:log4net.Layout.Layout2RawLayoutAdapter.#ctor(log4net.Layout.ILayout)">
- <summary>
- Construct a new adapter
- </summary>
- <param name="layout">the layout to adapt</param>
- <remarks>
- <para>
- Create the adapter for the specified <paramref name="layout"/>.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Layout.Layout2RawLayoutAdapter.Format(log4net.Core.LoggingEvent)">
- <summary>
- Format the logging event as an object.
- </summary>
- <param name="loggingEvent">The event to format</param>
- <returns>returns the formatted event</returns>
- <remarks>
- <para>
- Format the logging event as an object.
- </para>
- <para>
- Uses the <see cref="T:log4net.Layout.ILayout"/> object supplied to
- the constructor to perform the formatting.
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Layout.RawLayoutConverter">
- <summary>
- Type converter for the <see cref="T:log4net.Layout.IRawLayout"/> interface
- </summary>
- <remarks>
- <para>
- Used to convert objects to the <see cref="T:log4net.Layout.IRawLayout"/> interface.
- Supports converting from the <see cref="T:log4net.Layout.ILayout"/> interface to
- the <see cref="T:log4net.Layout.IRawLayout"/> interface using the <see cref="T:log4net.Layout.Layout2RawLayoutAdapter"/>.
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- <author>Gert Driesen</author>
- </member>
- <member name="T:log4net.Util.TypeConverters.IConvertFrom">
- <summary>
- Interface supported by type converters
- </summary>
- <remarks>
- <para>
- This interface supports conversion from arbitrary types
- to a single target type. See <see cref="T:log4net.Util.TypeConverters.TypeConverterAttribute"/>.
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- <author>Gert Driesen</author>
- </member>
- <member name="M:log4net.Util.TypeConverters.IConvertFrom.CanConvertFrom(System.Type)">
- <summary>
- Can the source type be converted to the type supported by this object
- </summary>
- <param name="sourceType">the type to convert</param>
- <returns>true if the conversion is possible</returns>
- <remarks>
- <para>
- Test if the <paramref name="sourceType"/> can be converted to the
- type supported by this converter.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.TypeConverters.IConvertFrom.ConvertFrom(System.Object)">
- <summary>
- Convert the source object to the type supported by this object
- </summary>
- <param name="source">the object to convert</param>
- <returns>the converted object</returns>
- <remarks>
- <para>
- Converts the <paramref name="source"/> to the type supported
- by this converter.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Layout.RawLayoutConverter.CanConvertFrom(System.Type)">
- <summary>
- Can the sourceType be converted to an <see cref="T:log4net.Layout.IRawLayout"/>
- </summary>
- <param name="sourceType">the source to be to be converted</param>
- <returns><c>true</c> if the source type can be converted to <see cref="T:log4net.Layout.IRawLayout"/></returns>
- <remarks>
- <para>
- Test if the <paramref name="sourceType"/> can be converted to a
- <see cref="T:log4net.Layout.IRawLayout"/>. Only <see cref="T:log4net.Layout.ILayout"/> is supported
- as the <paramref name="sourceType"/>.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Layout.RawLayoutConverter.ConvertFrom(System.Object)">
- <summary>
- Convert the value to a <see cref="T:log4net.Layout.IRawLayout"/> object
- </summary>
- <param name="source">the value to convert</param>
- <returns>the <see cref="T:log4net.Layout.IRawLayout"/> object</returns>
- <remarks>
- <para>
- Convert the <paramref name="source"/> object to a
- <see cref="T:log4net.Layout.IRawLayout"/> object. If the <paramref name="source"/> object
- is a <see cref="T:log4net.Layout.ILayout"/> then the <see cref="T:log4net.Layout.Layout2RawLayoutAdapter"/>
- is used to adapt between the two interfaces, otherwise an
- exception is thrown.
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Layout.RawPropertyLayout">
- <summary>
- Extract the value of a property from the <see cref="T:log4net.Core.LoggingEvent"/>
- </summary>
- <remarks>
- <para>
- Extract the value of a property from the <see cref="T:log4net.Core.LoggingEvent"/>
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- </member>
- <member name="M:log4net.Layout.RawPropertyLayout.#ctor">
- <summary>
- Constructs a RawPropertyLayout
- </summary>
- </member>
- <member name="M:log4net.Layout.RawPropertyLayout.Format(log4net.Core.LoggingEvent)">
- <summary>
- Lookup the property for <see cref="P:log4net.Layout.RawPropertyLayout.Key"/>
- </summary>
- <param name="loggingEvent">The event to format</param>
- <returns>returns property value</returns>
- <remarks>
- <para>
- Looks up and returns the object value of the property
- named <see cref="P:log4net.Layout.RawPropertyLayout.Key"/>. If there is no property defined
- with than name then <c>null</c> will be returned.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Layout.RawPropertyLayout.Key">
- <summary>
- The name of the value to lookup in the LoggingEvent Properties collection.
- </summary>
- <value>
- Value to lookup in the LoggingEvent Properties collection
- </value>
- <remarks>
- <para>
- String name of the property to lookup in the <see cref="T:log4net.Core.LoggingEvent"/>.
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Layout.RawTimeStampLayout">
- <summary>
- Extract the date from the <see cref="T:log4net.Core.LoggingEvent"/>
- </summary>
- <remarks>
- <para>
- Extract the date from the <see cref="T:log4net.Core.LoggingEvent"/>
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- <author>Gert Driesen</author>
- </member>
- <member name="M:log4net.Layout.RawTimeStampLayout.#ctor">
- <summary>
- Constructs a RawTimeStampLayout
- </summary>
- </member>
- <member name="M:log4net.Layout.RawTimeStampLayout.Format(log4net.Core.LoggingEvent)">
- <summary>
- Gets the <see cref="P:log4net.Core.LoggingEvent.TimeStamp"/> as a <see cref="T:System.DateTime"/>.
- </summary>
- <param name="loggingEvent">The event to format</param>
- <returns>returns the time stamp</returns>
- <remarks>
- <para>
- Gets the <see cref="P:log4net.Core.LoggingEvent.TimeStamp"/> as a <see cref="T:System.DateTime"/>.
- </para>
- <para>
- The time stamp is in local time. To format the time stamp
- in universal time use <see cref="T:log4net.Layout.RawUtcTimeStampLayout"/>.
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Layout.RawUtcTimeStampLayout">
- <summary>
- Extract the date from the <see cref="T:log4net.Core.LoggingEvent"/>
- </summary>
- <remarks>
- <para>
- Extract the date from the <see cref="T:log4net.Core.LoggingEvent"/>
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- <author>Gert Driesen</author>
- </member>
- <member name="M:log4net.Layout.RawUtcTimeStampLayout.#ctor">
- <summary>
- Constructs a RawUtcTimeStampLayout
- </summary>
- </member>
- <member name="M:log4net.Layout.RawUtcTimeStampLayout.Format(log4net.Core.LoggingEvent)">
- <summary>
- Gets the <see cref="P:log4net.Core.LoggingEvent.TimeStamp"/> as a <see cref="T:System.DateTime"/>.
- </summary>
- <param name="loggingEvent">The event to format</param>
- <returns>returns the time stamp</returns>
- <remarks>
- <para>
- Gets the <see cref="P:log4net.Core.LoggingEvent.TimeStamp"/> as a <see cref="T:System.DateTime"/>.
- </para>
- <para>
- The time stamp is in universal time. To format the time stamp
- in local time use <see cref="T:log4net.Layout.RawTimeStampLayout"/>.
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Layout.SimpleLayout">
- <summary>
- A very simple layout
- </summary>
- <remarks>
- <para>
- SimpleLayout consists of the level of the log statement,
- followed by " - " and then the log message itself. For example,
- <code>
- DEBUG - Hello world
- </code>
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- <author>Gert Driesen</author>
- </member>
- <member name="M:log4net.Layout.SimpleLayout.#ctor">
- <summary>
- Constructs a SimpleLayout
- </summary>
- </member>
- <member name="M:log4net.Layout.SimpleLayout.ActivateOptions">
- <summary>
- Initialize layout options
- </summary>
- <remarks>
- <para>
- This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
- activation scheme. The <see cref="M:log4net.Layout.SimpleLayout.ActivateOptions"/> method must
- be called on this object after the configuration properties have
- been set. Until <see cref="M:log4net.Layout.SimpleLayout.ActivateOptions"/> is called this
- object is in an undefined state and must not be used.
- </para>
- <para>
- If any of the configuration properties are modified then
- <see cref="M:log4net.Layout.SimpleLayout.ActivateOptions"/> must be called again.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Layout.SimpleLayout.Format(System.IO.TextWriter,log4net.Core.LoggingEvent)">
- <summary>
- Produces a simple formatted output.
- </summary>
- <param name="loggingEvent">the event being logged</param>
- <param name="writer">The TextWriter to write the formatted event to</param>
- <remarks>
- <para>
- Formats the event as the level of the even,
- followed by " - " and then the log message itself. The
- output is terminated by a newline.
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Layout.XmlLayout">
- <summary>
- Layout that formats the log events as XML elements.
- </summary>
- <remarks>
- <para>
- The output of the <see cref="T:log4net.Layout.XmlLayout"/> consists of a series of
- log4net:event elements. It does not output a complete well-formed XML
- file. The output is designed to be included as an <em>external entity</em>
- in a separate file to form a correct XML file.
- </para>
- <para>
- For example, if <c>abc</c> is the name of the file where
- the <see cref="T:log4net.Layout.XmlLayout"/> output goes, then a well-formed XML file would
- be:
- </para>
- <code lang="XML">
- <?xml version="1.0" ?>
-
- <!DOCTYPE log4net:events SYSTEM "log4net-events.dtd" [<!ENTITY data SYSTEM "abc">]>
-
- <log4net:events version="1.2" xmlns:log4net="http://logging.apache.org/log4net/schemas/log4net-events-1.2>
- &data;
- </log4net:events>
- </code>
- <para>
- This approach enforces the independence of the <see cref="T:log4net.Layout.XmlLayout"/>
- and the appender where it is embedded.
- </para>
- <para>
- The <c>version</c> attribute helps components to correctly
- interpret output generated by <see cref="T:log4net.Layout.XmlLayout"/>. The value of
- this attribute should be "1.2" for release 1.2 and later.
- </para>
- <para>
- Alternatively the <c>Header</c> and <c>Footer</c> properties can be
- configured to output the correct XML header, open tag and close tag.
- When setting the <c>Header</c> and <c>Footer</c> properties it is essential
- that the underlying data store not be appendable otherwise the data
- will become invalid XML.
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- <author>Gert Driesen</author>
- </member>
- <member name="T:log4net.Layout.XmlLayoutBase">
- <summary>
- Layout that formats the log events as XML elements.
- </summary>
- <remarks>
- <para>
- This is an abstract class that must be subclassed by an implementation
- to conform to a specific schema.
- </para>
- <para>
- Deriving classes must implement the <see cref="M:log4net.Layout.XmlLayoutBase.FormatXml(System.Xml.XmlWriter,log4net.Core.LoggingEvent)"/> method.
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- <author>Gert Driesen</author>
- </member>
- <member name="M:log4net.Layout.XmlLayoutBase.#ctor">
- <summary>
- Protected constructor to support subclasses
- </summary>
- <remarks>
- <para>
- Initializes a new instance of the <see cref="T:log4net.Layout.XmlLayoutBase"/> class
- with no location info.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Layout.XmlLayoutBase.#ctor(System.Boolean)">
- <summary>
- Protected constructor to support subclasses
- </summary>
- <remarks>
- <para>
- The <paramref name="locationInfo" /> parameter determines whether
- location information will be output by the layout. If
- <paramref name="locationInfo" /> is set to <c>true</c>, then the
- file name and line number of the statement at the origin of the log
- statement will be output.
- </para>
- <para>
- If you are embedding this layout within an SMTPAppender
- then make sure to set the <b>LocationInfo</b> option of that
- appender as well.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Layout.XmlLayoutBase.ActivateOptions">
- <summary>
- Initialize layout options
- </summary>
- <remarks>
- <para>
- This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
- activation scheme. The <see cref="M:log4net.Layout.XmlLayoutBase.ActivateOptions"/> method must
- be called on this object after the configuration properties have
- been set. Until <see cref="M:log4net.Layout.XmlLayoutBase.ActivateOptions"/> is called this
- object is in an undefined state and must not be used.
- </para>
- <para>
- If any of the configuration properties are modified then
- <see cref="M:log4net.Layout.XmlLayoutBase.ActivateOptions"/> must be called again.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Layout.XmlLayoutBase.Format(System.IO.TextWriter,log4net.Core.LoggingEvent)">
- <summary>
- Produces a formatted string.
- </summary>
- <param name="loggingEvent">The event being logged.</param>
- <param name="writer">The TextWriter to write the formatted event to</param>
- <remarks>
- <para>
- Format the <see cref="T:log4net.Core.LoggingEvent"/> and write it to the <see cref="T:System.IO.TextWriter"/>.
- </para>
- <para>
- This method creates an <see cref="T:System.Xml.XmlTextWriter"/> that writes to the
- <paramref name="writer"/>. The <see cref="T:System.Xml.XmlTextWriter"/> is passed
- to the <see cref="M:log4net.Layout.XmlLayoutBase.FormatXml(System.Xml.XmlWriter,log4net.Core.LoggingEvent)"/> method. Subclasses should override the
- <see cref="M:log4net.Layout.XmlLayoutBase.FormatXml(System.Xml.XmlWriter,log4net.Core.LoggingEvent)"/> method rather than this method.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Layout.XmlLayoutBase.FormatXml(System.Xml.XmlWriter,log4net.Core.LoggingEvent)">
- <summary>
- Does the actual writing of the XML.
- </summary>
- <param name="writer">The writer to use to output the event to.</param>
- <param name="loggingEvent">The event to write.</param>
- <remarks>
- <para>
- Subclasses should override this method to format
- the <see cref="T:log4net.Core.LoggingEvent"/> as XML.
- </para>
- </remarks>
- </member>
- <member name="F:log4net.Layout.XmlLayoutBase.m_locationInfo">
- <summary>
- Flag to indicate if location information should be included in
- the XML events.
- </summary>
- </member>
- <member name="F:log4net.Layout.XmlLayoutBase.m_invalidCharReplacement">
- <summary>
- The string to replace invalid chars with
- </summary>
- </member>
- <member name="P:log4net.Layout.XmlLayoutBase.LocationInfo">
- <summary>
- Gets a value indicating whether to include location information in
- the XML events.
- </summary>
- <value>
- <c>true</c> if location information should be included in the XML
- events; otherwise, <c>false</c>.
- </value>
- <remarks>
- <para>
- If <see cref="P:log4net.Layout.XmlLayoutBase.LocationInfo"/> is set to <c>true</c>, then the file
- name and line number of the statement at the origin of the log
- statement will be output.
- </para>
- <para>
- If you are embedding this layout within an <c>SMTPAppender</c>
- then make sure to set the <b>LocationInfo</b> option of that
- appender as well.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Layout.XmlLayoutBase.InvalidCharReplacement">
- <summary>
- The string to replace characters that can not be expressed in XML with.
- <remarks>
- <para>
- Not all characters may be expressed in XML. This property contains the
- string to replace those that can not with. This defaults to a ?. Set it
- to the empty string to simply remove offending characters. For more
- details on the allowed character ranges see http://www.w3.org/TR/REC-xml/#charsets
- Character replacement will occur in the log message, the property names
- and the property values.
- </para>
- </remarks>
- </summary>
- </member>
- <member name="P:log4net.Layout.XmlLayoutBase.ContentType">
- <summary>
- Gets the content type output by this layout.
- </summary>
- <value>
- As this is the XML layout, the value is always <c>"text/xml"</c>.
- </value>
- <remarks>
- <para>
- As this is the XML layout, the value is always <c>"text/xml"</c>.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Layout.XmlLayout.#ctor">
- <summary>
- Constructs an XmlLayout
- </summary>
- </member>
- <member name="M:log4net.Layout.XmlLayout.#ctor(System.Boolean)">
- <summary>
- Constructs an XmlLayout.
- </summary>
- <remarks>
- <para>
- The <b>LocationInfo</b> option takes a boolean value. By
- default, it is set to false which means there will be no location
- information output by this layout. If the the option is set to
- true, then the file name and line number of the statement
- at the origin of the log statement will be output.
- </para>
- <para>
- If you are embedding this layout within an SmtpAppender
- then make sure to set the <b>LocationInfo</b> option of that
- appender as well.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Layout.XmlLayout.ActivateOptions">
- <summary>
- Initialize layout options
- </summary>
- <remarks>
- <para>
- This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
- activation scheme. The <see cref="M:log4net.Layout.XmlLayout.ActivateOptions"/> method must
- be called on this object after the configuration properties have
- been set. Until <see cref="M:log4net.Layout.XmlLayout.ActivateOptions"/> is called this
- object is in an undefined state and must not be used.
- </para>
- <para>
- If any of the configuration properties are modified then
- <see cref="M:log4net.Layout.XmlLayout.ActivateOptions"/> must be called again.
- </para>
- <para>
- Builds a cache of the element names
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Layout.XmlLayout.FormatXml(System.Xml.XmlWriter,log4net.Core.LoggingEvent)">
- <summary>
- Does the actual writing of the XML.
- </summary>
- <param name="writer">The writer to use to output the event to.</param>
- <param name="loggingEvent">The event to write.</param>
- <remarks>
- <para>
- Override the base class <see cref="M:log4net.Layout.XmlLayoutBase.FormatXml(System.Xml.XmlWriter,log4net.Core.LoggingEvent)"/> method
- to write the <see cref="T:log4net.Core.LoggingEvent"/> to the <see cref="T:System.Xml.XmlWriter"/>.
- </para>
- </remarks>
- </member>
- <member name="F:log4net.Layout.XmlLayout.m_prefix">
- <summary>
- The prefix to use for all generated element names
- </summary>
- </member>
- <member name="P:log4net.Layout.XmlLayout.Prefix">
- <summary>
- The prefix to use for all element names
- </summary>
- <remarks>
- <para>
- The default prefix is <b>log4net</b>. Set this property
- to change the prefix. If the prefix is set to an empty string
- then no prefix will be written.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Layout.XmlLayout.Base64EncodeMessage">
- <summary>
- Set whether or not to base64 encode the message.
- </summary>
- <remarks>
- <para>
- By default the log message will be written as text to the xml
- output. This can cause problems when the message contains binary
- data. By setting this to true the contents of the message will be
- base64 encoded. If this is set then invalid character replacement
- (see <see cref="P:log4net.Layout.XmlLayoutBase.InvalidCharReplacement"/>) will not be performed
- on the log message.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Layout.XmlLayout.Base64EncodeProperties">
- <summary>
- Set whether or not to base64 encode the property values.
- </summary>
- <remarks>
- <para>
- By default the properties will be written as text to the xml
- output. This can cause problems when one or more properties contain
- binary data. By setting this to true the values of the properties
- will be base64 encoded. If this is set then invalid character replacement
- (see <see cref="P:log4net.Layout.XmlLayoutBase.InvalidCharReplacement"/>) will not be performed
- on the property values.
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Layout.XmlLayoutSchemaLog4j">
- <summary>
- Layout that formats the log events as XML elements compatible with the log4j schema
- </summary>
- <remarks>
- <para>
- Formats the log events according to the http://logging.apache.org/log4j schema.
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- </member>
- <member name="F:log4net.Layout.XmlLayoutSchemaLog4j.s_date1970">
- <summary>
- The 1st of January 1970 in UTC
- </summary>
- </member>
- <member name="M:log4net.Layout.XmlLayoutSchemaLog4j.#ctor">
- <summary>
- Constructs an XMLLayoutSchemaLog4j
- </summary>
- </member>
- <member name="M:log4net.Layout.XmlLayoutSchemaLog4j.#ctor(System.Boolean)">
- <summary>
- Constructs an XMLLayoutSchemaLog4j.
- </summary>
- <remarks>
- <para>
- The <b>LocationInfo</b> option takes a boolean value. By
- default, it is set to false which means there will be no location
- information output by this layout. If the the option is set to
- true, then the file name and line number of the statement
- at the origin of the log statement will be output.
- </para>
- <para>
- If you are embedding this layout within an SMTPAppender
- then make sure to set the <b>LocationInfo</b> option of that
- appender as well.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Layout.XmlLayoutSchemaLog4j.FormatXml(System.Xml.XmlWriter,log4net.Core.LoggingEvent)">
- <summary>
- Actually do the writing of the xml
- </summary>
- <param name="writer">the writer to use</param>
- <param name="loggingEvent">the event to write</param>
- <remarks>
- <para>
- Generate XML that is compatible with the log4j schema.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Layout.XmlLayoutSchemaLog4j.Version">
- <summary>
- The version of the log4j schema to use.
- </summary>
- <remarks>
- <para>
- Only version 1.2 of the log4j schema is supported.
- </para>
- </remarks>
- </member>
- <member name="T:log4net.ObjectRenderer.DefaultRenderer">
- <summary>
- The default object Renderer.
- </summary>
- <remarks>
- <para>
- The default renderer supports rendering objects and collections to strings.
- </para>
- <para>
- See the <see cref="M:log4net.ObjectRenderer.DefaultRenderer.RenderObject(log4net.ObjectRenderer.RendererMap,System.Object,System.IO.TextWriter)"/> method for details of the output.
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- <author>Gert Driesen</author>
- </member>
- <member name="T:log4net.ObjectRenderer.IObjectRenderer">
- <summary>
- Implement this interface in order to render objects as strings
- </summary>
- <remarks>
- <para>
- Certain types require special case conversion to
- string form. This conversion is done by an object renderer.
- Object renderers implement the <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>
- interface.
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- <author>Gert Driesen</author>
- </member>
- <member name="M:log4net.ObjectRenderer.IObjectRenderer.RenderObject(log4net.ObjectRenderer.RendererMap,System.Object,System.IO.TextWriter)">
- <summary>
- Render the object <paramref name="obj"/> to a string
- </summary>
- <param name="rendererMap">The map used to lookup renderers</param>
- <param name="obj">The object to render</param>
- <param name="writer">The writer to render to</param>
- <remarks>
- <para>
- Render the object <paramref name="obj"/> to a
- string.
- </para>
- <para>
- The <paramref name="rendererMap"/> parameter is
- provided to lookup and render other objects. This is
- very useful where <paramref name="obj"/> contains
- nested objects of unknown type. The <see cref="M:RendererMap.FindAndRender(object, TextWriter)"/>
- method can be used to render these objects.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.ObjectRenderer.DefaultRenderer.#ctor">
- <summary>
- Default constructor
- </summary>
- <remarks>
- <para>
- Default constructor
- </para>
- </remarks>
- </member>
- <member name="M:log4net.ObjectRenderer.DefaultRenderer.RenderObject(log4net.ObjectRenderer.RendererMap,System.Object,System.IO.TextWriter)">
- <summary>
- Render the object <paramref name="obj"/> to a string
- </summary>
- <param name="rendererMap">The map used to lookup renderers</param>
- <param name="obj">The object to render</param>
- <param name="writer">The writer to render to</param>
- <remarks>
- <para>
- Render the object <paramref name="obj"/> to a string.
- </para>
- <para>
- The <paramref name="rendererMap"/> parameter is
- provided to lookup and render other objects. This is
- very useful where <paramref name="obj"/> contains
- nested objects of unknown type. The <see cref="M:RendererMap.FindAndRender(object)"/>
- method can be used to render these objects.
- </para>
- <para>
- The default renderer supports rendering objects to strings as follows:
- </para>
- <list type="table">
- <listheader>
- <term>Value</term>
- <description>Rendered String</description>
- </listheader>
- <item>
- <term><c>null</c></term>
- <description>
- <para>"(null)"</para>
- </description>
- </item>
- <item>
- <term><see cref="T:System.Array"/></term>
- <description>
- <para>
- For a one dimensional array this is the
- array type name, an open brace, followed by a comma
- separated list of the elements (using the appropriate
- renderer), followed by a close brace.
- </para>
- <para>
- For example: <c>int[] {1, 2, 3}</c>.
- </para>
- <para>
- If the array is not one dimensional the
- <c>Array.ToString()</c> is returned.
- </para>
- </description>
- </item>
- <item>
- <term><see cref="T:System.Collections.IEnumerable"/>, <see cref="T:System.Collections.ICollection"/> & <see cref="T:System.Collections.IEnumerator"/></term>
- <description>
- <para>
- Rendered as an open brace, followed by a comma
- separated list of the elements (using the appropriate
- renderer), followed by a close brace.
- </para>
- <para>
- For example: <c>{a, b, c}</c>.
- </para>
- <para>
- All collection classes that implement <see cref="T:System.Collections.ICollection"/> its subclasses,
- or generic equivalents all implement the <see cref="T:System.Collections.IEnumerable"/> interface.
- </para>
- </description>
- </item>
- <item>
- <term><see cref="T:System.Collections.DictionaryEntry"/></term>
- <description>
- <para>
- Rendered as the key, an equals sign ('='), and the value (using the appropriate
- renderer).
- </para>
- <para>
- For example: <c>key=value</c>.
- </para>
- </description>
- </item>
- <item>
- <term>other</term>
- <description>
- <para><c>Object.ToString()</c></para>
- </description>
- </item>
- </list>
- </remarks>
- </member>
- <member name="M:log4net.ObjectRenderer.DefaultRenderer.RenderArray(log4net.ObjectRenderer.RendererMap,System.Array,System.IO.TextWriter)">
- <summary>
- Render the array argument into a string
- </summary>
- <param name="rendererMap">The map used to lookup renderers</param>
- <param name="array">the array to render</param>
- <param name="writer">The writer to render to</param>
- <remarks>
- <para>
- For a one dimensional array this is the
- array type name, an open brace, followed by a comma
- separated list of the elements (using the appropriate
- renderer), followed by a close brace. For example:
- <c>int[] {1, 2, 3}</c>.
- </para>
- <para>
- If the array is not one dimensional the
- <c>Array.ToString()</c> is returned.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.ObjectRenderer.DefaultRenderer.RenderEnumerator(log4net.ObjectRenderer.RendererMap,System.Collections.IEnumerator,System.IO.TextWriter)">
- <summary>
- Render the enumerator argument into a string
- </summary>
- <param name="rendererMap">The map used to lookup renderers</param>
- <param name="enumerator">the enumerator to render</param>
- <param name="writer">The writer to render to</param>
- <remarks>
- <para>
- Rendered as an open brace, followed by a comma
- separated list of the elements (using the appropriate
- renderer), followed by a close brace. For example:
- <c>{a, b, c}</c>.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.ObjectRenderer.DefaultRenderer.RenderDictionaryEntry(log4net.ObjectRenderer.RendererMap,System.Collections.DictionaryEntry,System.IO.TextWriter)">
- <summary>
- Render the DictionaryEntry argument into a string
- </summary>
- <param name="rendererMap">The map used to lookup renderers</param>
- <param name="entry">the DictionaryEntry to render</param>
- <param name="writer">The writer to render to</param>
- <remarks>
- <para>
- Render the key, an equals sign ('='), and the value (using the appropriate
- renderer). For example: <c>key=value</c>.
- </para>
- </remarks>
- </member>
- <member name="T:log4net.ObjectRenderer.RendererMap">
- <summary>
- Map class objects to an <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>.
- </summary>
- <remarks>
- <para>
- Maintains a mapping between types that require special
- rendering and the <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/> that
- is used to render them.
- </para>
- <para>
- The <see cref="M:FindAndRender(object)"/> method is used to render an
- <c>object</c> using the appropriate renderers defined in this map.
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- <author>Gert Driesen</author>
- </member>
- <member name="M:log4net.ObjectRenderer.RendererMap.#ctor">
- <summary>
- Default Constructor
- </summary>
- <remarks>
- <para>
- Default constructor.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.ObjectRenderer.RendererMap.FindAndRender(System.Object)">
- <summary>
- Render <paramref name="obj"/> using the appropriate renderer.
- </summary>
- <param name="obj">the object to render to a string</param>
- <returns>the object rendered as a string</returns>
- <remarks>
- <para>
- This is a convenience method used to render an object to a string.
- The alternative method <see cref="M:FindAndRender(object,TextWriter)"/>
- should be used when streaming output to a <see cref="T:System.IO.TextWriter"/>.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.ObjectRenderer.RendererMap.FindAndRender(System.Object,System.IO.TextWriter)">
- <summary>
- Render <paramref name="obj"/> using the appropriate renderer.
- </summary>
- <param name="obj">the object to render to a string</param>
- <param name="writer">The writer to render to</param>
- <remarks>
- <para>
- Find the appropriate renderer for the type of the
- <paramref name="obj"/> parameter. This is accomplished by calling the
- <see cref="M:Get(Type)"/> method. Once a renderer is found, it is
- applied on the object <paramref name="obj"/> and the result is returned
- as a <see cref="T:System.String"/>.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.ObjectRenderer.RendererMap.Get(System.Object)">
- <summary>
- Gets the renderer for the specified object type
- </summary>
- <param name="obj">the object to lookup the renderer for</param>
- <returns>the renderer for <paramref name="obj"/></returns>
- <remarks>
- <param>
- Gets the renderer for the specified object type.
- </param>
- <param>
- Syntactic sugar method that calls <see cref="M:Get(Type)"/>
- with the type of the object parameter.
- </param>
- </remarks>
- </member>
- <member name="M:log4net.ObjectRenderer.RendererMap.Get(System.Type)">
- <summary>
- Gets the renderer for the specified type
- </summary>
- <param name="type">the type to lookup the renderer for</param>
- <returns>the renderer for the specified type</returns>
- <remarks>
- <para>
- Returns the renderer for the specified type.
- If no specific renderer has been defined the
- <see cref="P:log4net.ObjectRenderer.RendererMap.DefaultRenderer"/> will be returned.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.ObjectRenderer.RendererMap.SearchTypeAndInterfaces(System.Type)">
- <summary>
- Internal function to recursively search interfaces
- </summary>
- <param name="type">the type to lookup the renderer for</param>
- <returns>the renderer for the specified type</returns>
- </member>
- <member name="M:log4net.ObjectRenderer.RendererMap.Clear">
- <summary>
- Clear the map of renderers
- </summary>
- <remarks>
- <para>
- Clear the custom renderers defined by using
- <see cref="M:log4net.ObjectRenderer.RendererMap.Put(System.Type,log4net.ObjectRenderer.IObjectRenderer)"/>. The <see cref="P:log4net.ObjectRenderer.RendererMap.DefaultRenderer"/>
- cannot be removed.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.ObjectRenderer.RendererMap.Put(System.Type,log4net.ObjectRenderer.IObjectRenderer)">
- <summary>
- Register an <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/> for <paramref name="typeToRender"/>.
- </summary>
- <param name="typeToRender">the type that will be rendered by <paramref name="renderer"/></param>
- <param name="renderer">the renderer for <paramref name="typeToRender"/></param>
- <remarks>
- <para>
- Register an object renderer for a specific source type.
- This renderer will be returned from a call to <see cref="M:Get(Type)"/>
- specifying the same <paramref name="typeToRender"/> as an argument.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.ObjectRenderer.RendererMap.DefaultRenderer">
- <summary>
- Get the default renderer instance
- </summary>
- <value>the default renderer</value>
- <remarks>
- <para>
- Get the default renderer
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Plugin.IPlugin">
- <summary>
- Interface implemented by logger repository plugins.
- </summary>
- <remarks>
- <para>
- Plugins define additional behavior that can be associated
- with a <see cref="T:log4net.Repository.ILoggerRepository"/>.
- The <see cref="T:log4net.Plugin.PluginMap"/> held by the <see cref="P:log4net.Repository.ILoggerRepository.PluginMap"/>
- property is used to store the plugins for a repository.
- </para>
- <para>
- The <c>log4net.Config.PluginAttribute</c> can be used to
- attach plugins to repositories created using configuration
- attributes.
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- <author>Gert Driesen</author>
- </member>
- <member name="M:log4net.Plugin.IPlugin.Attach(log4net.Repository.ILoggerRepository)">
- <summary>
- Attaches the plugin to the specified <see cref="T:log4net.Repository.ILoggerRepository"/>.
- </summary>
- <param name="repository">The <see cref="T:log4net.Repository.ILoggerRepository"/> that this plugin should be attached to.</param>
- <remarks>
- <para>
- A plugin may only be attached to a single repository.
- </para>
- <para>
- This method is called when the plugin is attached to the repository.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Plugin.IPlugin.Shutdown">
- <summary>
- Is called when the plugin is to shutdown.
- </summary>
- <remarks>
- <para>
- This method is called to notify the plugin that
- it should stop operating and should detach from
- the repository.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Plugin.IPlugin.Name">
- <summary>
- Gets the name of the plugin.
- </summary>
- <value>
- The name of the plugin.
- </value>
- <remarks>
- <para>
- Plugins are stored in the <see cref="T:log4net.Plugin.PluginMap"/>
- keyed by name. Each plugin instance attached to a
- repository must be a unique name.
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Plugin.PluginCollection">
- <summary>
- A strongly-typed collection of <see cref="T:log4net.Plugin.IPlugin"/> objects.
- </summary>
- <author>Nicko Cadell</author>
- </member>
- <member name="M:log4net.Plugin.PluginCollection.ReadOnly(log4net.Plugin.PluginCollection)">
- <summary>
- Creates a read-only wrapper for a <c>PluginCollection</c> instance.
- </summary>
- <param name="list">list to create a readonly wrapper arround</param>
- <returns>
- A <c>PluginCollection</c> wrapper that is read-only.
- </returns>
- </member>
- <member name="M:log4net.Plugin.PluginCollection.#ctor">
- <summary>
- Initializes a new instance of the <c>PluginCollection</c> class
- that is empty and has the default initial capacity.
- </summary>
- </member>
- <member name="M:log4net.Plugin.PluginCollection.#ctor(System.Int32)">
- <summary>
- Initializes a new instance of the <c>PluginCollection</c> class
- that has the specified initial capacity.
- </summary>
- <param name="capacity">
- The number of elements that the new <c>PluginCollection</c> is initially capable of storing.
- </param>
- </member>
- <member name="M:log4net.Plugin.PluginCollection.#ctor(log4net.Plugin.PluginCollection)">
- <summary>
- Initializes a new instance of the <c>PluginCollection</c> class
- that contains elements copied from the specified <c>PluginCollection</c>.
- </summary>
- <param name="c">The <c>PluginCollection</c> whose elements are copied to the new collection.</param>
- </member>
- <member name="M:log4net.Plugin.PluginCollection.#ctor(log4net.Plugin.IPlugin[])">
- <summary>
- Initializes a new instance of the <c>PluginCollection</c> class
- that contains elements copied from the specified <see cref="T:log4net.Plugin.IPlugin"/> array.
- </summary>
- <param name="a">The <see cref="T:log4net.Plugin.IPlugin"/> array whose elements are copied to the new list.</param>
- </member>
- <member name="M:log4net.Plugin.PluginCollection.#ctor(System.Collections.ICollection)">
- <summary>
- Initializes a new instance of the <c>PluginCollection</c> class
- that contains elements copied from the specified <see cref="T:log4net.Plugin.IPlugin"/> collection.
- </summary>
- <param name="col">The <see cref="T:log4net.Plugin.IPlugin"/> collection whose elements are copied to the new list.</param>
- </member>
- <member name="M:log4net.Plugin.PluginCollection.#ctor(log4net.Plugin.PluginCollection.Tag)">
- <summary>
- Allow subclasses to avoid our default constructors
- </summary>
- <param name="tag"></param>
- <exclude/>
- </member>
- <member name="M:log4net.Plugin.PluginCollection.CopyTo(log4net.Plugin.IPlugin[])">
- <summary>
- Copies the entire <c>PluginCollection</c> to a one-dimensional
- <see cref="T:log4net.Plugin.IPlugin"/> array.
- </summary>
- <param name="array">The one-dimensional <see cref="T:log4net.Plugin.IPlugin"/> array to copy to.</param>
- </member>
- <member name="M:log4net.Plugin.PluginCollection.CopyTo(log4net.Plugin.IPlugin[],System.Int32)">
- <summary>
- Copies the entire <c>PluginCollection</c> to a one-dimensional
- <see cref="T:log4net.Plugin.IPlugin"/> array, starting at the specified index of the target array.
- </summary>
- <param name="array">The one-dimensional <see cref="T:log4net.Plugin.IPlugin"/> array to copy to.</param>
- <param name="start">The zero-based index in <paramref name="array"/> at which copying begins.</param>
- </member>
- <member name="M:log4net.Plugin.PluginCollection.Add(log4net.Plugin.IPlugin)">
- <summary>
- Adds a <see cref="T:log4net.Plugin.IPlugin"/> to the end of the <c>PluginCollection</c>.
- </summary>
- <param name="item">The <see cref="T:log4net.Plugin.IPlugin"/> to be added to the end of the <c>PluginCollection</c>.</param>
- <returns>The index at which the value has been added.</returns>
- </member>
- <member name="M:log4net.Plugin.PluginCollection.Clear">
- <summary>
- Removes all elements from the <c>PluginCollection</c>.
- </summary>
- </member>
- <member name="M:log4net.Plugin.PluginCollection.Clone">
- <summary>
- Creates a shallow copy of the <see cref="T:log4net.Plugin.PluginCollection"/>.
- </summary>
- <returns>A new <see cref="T:log4net.Plugin.PluginCollection"/> with a shallow copy of the collection data.</returns>
- </member>
- <member name="M:log4net.Plugin.PluginCollection.Contains(log4net.Plugin.IPlugin)">
- <summary>
- Determines whether a given <see cref="T:log4net.Plugin.IPlugin"/> is in the <c>PluginCollection</c>.
- </summary>
- <param name="item">The <see cref="T:log4net.Plugin.IPlugin"/> to check for.</param>
- <returns><c>true</c> if <paramref name="item"/> is found in the <c>PluginCollection</c>; otherwise, <c>false</c>.</returns>
- </member>
- <member name="M:log4net.Plugin.PluginCollection.IndexOf(log4net.Plugin.IPlugin)">
- <summary>
- Returns the zero-based index of the first occurrence of a <see cref="T:log4net.Plugin.IPlugin"/>
- in the <c>PluginCollection</c>.
- </summary>
- <param name="item">The <see cref="T:log4net.Plugin.IPlugin"/> to locate in the <c>PluginCollection</c>.</param>
- <returns>
- The zero-based index of the first occurrence of <paramref name="item"/>
- in the entire <c>PluginCollection</c>, if found; otherwise, -1.
- </returns>
- </member>
- <member name="M:log4net.Plugin.PluginCollection.Insert(System.Int32,log4net.Plugin.IPlugin)">
- <summary>
- Inserts an element into the <c>PluginCollection</c> at the specified index.
- </summary>
- <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
- <param name="item">The <see cref="T:log4net.Plugin.IPlugin"/> to insert.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="index"/> is less than zero</para>
- <para>-or-</para>
- <para><paramref name="index"/> is equal to or greater than <see cref="P:log4net.Plugin.PluginCollection.Count"/>.</para>
- </exception>
- </member>
- <member name="M:log4net.Plugin.PluginCollection.Remove(log4net.Plugin.IPlugin)">
- <summary>
- Removes the first occurrence of a specific <see cref="T:log4net.Plugin.IPlugin"/> from the <c>PluginCollection</c>.
- </summary>
- <param name="item">The <see cref="T:log4net.Plugin.IPlugin"/> to remove from the <c>PluginCollection</c>.</param>
- <exception cref="T:System.ArgumentException">
- The specified <see cref="T:log4net.Plugin.IPlugin"/> was not found in the <c>PluginCollection</c>.
- </exception>
- </member>
- <member name="M:log4net.Plugin.PluginCollection.RemoveAt(System.Int32)">
- <summary>
- Removes the element at the specified index of the <c>PluginCollection</c>.
- </summary>
- <param name="index">The zero-based index of the element to remove.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="index"/> is less than zero.</para>
- <para>-or-</para>
- <para><paramref name="index"/> is equal to or greater than <see cref="P:log4net.Plugin.PluginCollection.Count"/>.</para>
- </exception>
- </member>
- <member name="M:log4net.Plugin.PluginCollection.GetEnumerator">
- <summary>
- Returns an enumerator that can iterate through the <c>PluginCollection</c>.
- </summary>
- <returns>An <see cref="T:log4net.Plugin.PluginCollection.Enumerator"/> for the entire <c>PluginCollection</c>.</returns>
- </member>
- <member name="M:log4net.Plugin.PluginCollection.AddRange(log4net.Plugin.PluginCollection)">
- <summary>
- Adds the elements of another <c>PluginCollection</c> to the current <c>PluginCollection</c>.
- </summary>
- <param name="x">The <c>PluginCollection</c> whose elements should be added to the end of the current <c>PluginCollection</c>.</param>
- <returns>The new <see cref="P:log4net.Plugin.PluginCollection.Count"/> of the <c>PluginCollection</c>.</returns>
- </member>
- <member name="M:log4net.Plugin.PluginCollection.AddRange(log4net.Plugin.IPlugin[])">
- <summary>
- Adds the elements of a <see cref="T:log4net.Plugin.IPlugin"/> array to the current <c>PluginCollection</c>.
- </summary>
- <param name="x">The <see cref="T:log4net.Plugin.IPlugin"/> array whose elements should be added to the end of the <c>PluginCollection</c>.</param>
- <returns>The new <see cref="P:log4net.Plugin.PluginCollection.Count"/> of the <c>PluginCollection</c>.</returns>
- </member>
- <member name="M:log4net.Plugin.PluginCollection.AddRange(System.Collections.ICollection)">
- <summary>
- Adds the elements of a <see cref="T:log4net.Plugin.IPlugin"/> collection to the current <c>PluginCollection</c>.
- </summary>
- <param name="col">The <see cref="T:log4net.Plugin.IPlugin"/> collection whose elements should be added to the end of the <c>PluginCollection</c>.</param>
- <returns>The new <see cref="P:log4net.Plugin.PluginCollection.Count"/> of the <c>PluginCollection</c>.</returns>
- </member>
- <member name="M:log4net.Plugin.PluginCollection.TrimToSize">
- <summary>
- Sets the capacity to the actual number of elements.
- </summary>
- </member>
- <member name="M:log4net.Plugin.PluginCollection.ValidateIndex(System.Int32)">
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="i"/> is less than zero.</para>
- <para>-or-</para>
- <para><paramref name="i"/> is equal to or greater than <see cref="P:log4net.Plugin.PluginCollection.Count"/>.</para>
- </exception>
- </member>
- <member name="M:log4net.Plugin.PluginCollection.ValidateIndex(System.Int32,System.Boolean)">
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="i"/> is less than zero.</para>
- <para>-or-</para>
- <para><paramref name="i"/> is equal to or greater than <see cref="P:log4net.Plugin.PluginCollection.Count"/>.</para>
- </exception>
- </member>
- <member name="P:log4net.Plugin.PluginCollection.Count">
- <summary>
- Gets the number of elements actually contained in the <c>PluginCollection</c>.
- </summary>
- </member>
- <member name="P:log4net.Plugin.PluginCollection.IsSynchronized">
- <summary>
- Gets a value indicating whether access to the collection is synchronized (thread-safe).
- </summary>
- <returns>true if access to the ICollection is synchronized (thread-safe); otherwise, false.</returns>
- </member>
- <member name="P:log4net.Plugin.PluginCollection.SyncRoot">
- <summary>
- Gets an object that can be used to synchronize access to the collection.
- </summary>
- <value>
- An object that can be used to synchronize access to the collection.
- </value>
- </member>
- <member name="P:log4net.Plugin.PluginCollection.Item(System.Int32)">
- <summary>
- Gets or sets the <see cref="T:log4net.Plugin.IPlugin"/> at the specified index.
- </summary>
- <value>
- The <see cref="T:log4net.Plugin.IPlugin"/> at the specified index.
- </value>
- <param name="index">The zero-based index of the element to get or set.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="index"/> is less than zero.</para>
- <para>-or-</para>
- <para><paramref name="index"/> is equal to or greater than <see cref="P:log4net.Plugin.PluginCollection.Count"/>.</para>
- </exception>
- </member>
- <member name="P:log4net.Plugin.PluginCollection.IsFixedSize">
- <summary>
- Gets a value indicating whether the collection has a fixed size.
- </summary>
- <value><c>true</c> if the collection has a fixed size; otherwise, <c>false</c>. The default is <c>false</c>.</value>
- </member>
- <member name="P:log4net.Plugin.PluginCollection.IsReadOnly">
- <summary>
- Gets a value indicating whether the IList is read-only.
- </summary>
- <value><c>true</c> if the collection is read-only; otherwise, <c>false</c>. The default is <c>false</c>.</value>
- </member>
- <member name="P:log4net.Plugin.PluginCollection.Capacity">
- <summary>
- Gets or sets the number of elements the <c>PluginCollection</c> can contain.
- </summary>
- <value>
- The number of elements the <c>PluginCollection</c> can contain.
- </value>
- </member>
- <member name="T:log4net.Plugin.PluginCollection.IPluginCollectionEnumerator">
- <summary>
- Supports type-safe iteration over a <see cref="T:log4net.Plugin.PluginCollection"/>.
- </summary>
- <exclude/>
- </member>
- <member name="M:log4net.Plugin.PluginCollection.IPluginCollectionEnumerator.MoveNext">
- <summary>
- Advances the enumerator to the next element in the collection.
- </summary>
- <returns>
- <c>true</c> if the enumerator was successfully advanced to the next element;
- <c>false</c> if the enumerator has passed the end of the collection.
- </returns>
- <exception cref="T:System.InvalidOperationException">
- The collection was modified after the enumerator was created.
- </exception>
- </member>
- <member name="M:log4net.Plugin.PluginCollection.IPluginCollectionEnumerator.Reset">
- <summary>
- Sets the enumerator to its initial position, before the first element in the collection.
- </summary>
- </member>
- <member name="P:log4net.Plugin.PluginCollection.IPluginCollectionEnumerator.Current">
- <summary>
- Gets the current element in the collection.
- </summary>
- </member>
- <member name="T:log4net.Plugin.PluginCollection.Tag">
- <summary>
- Type visible only to our subclasses
- Used to access protected constructor
- </summary>
- <exclude/>
- </member>
- <member name="F:log4net.Plugin.PluginCollection.Tag.Default">
- <summary>
- A value
- </summary>
- </member>
- <member name="T:log4net.Plugin.PluginCollection.Enumerator">
- <summary>
- Supports simple iteration over a <see cref="T:log4net.Plugin.PluginCollection"/>.
- </summary>
- <exclude/>
- </member>
- <member name="M:log4net.Plugin.PluginCollection.Enumerator.#ctor(log4net.Plugin.PluginCollection)">
- <summary>
- Initializes a new instance of the <c>Enumerator</c> class.
- </summary>
- <param name="tc"></param>
- </member>
- <member name="M:log4net.Plugin.PluginCollection.Enumerator.MoveNext">
- <summary>
- Advances the enumerator to the next element in the collection.
- </summary>
- <returns>
- <c>true</c> if the enumerator was successfully advanced to the next element;
- <c>false</c> if the enumerator has passed the end of the collection.
- </returns>
- <exception cref="T:System.InvalidOperationException">
- The collection was modified after the enumerator was created.
- </exception>
- </member>
- <member name="M:log4net.Plugin.PluginCollection.Enumerator.Reset">
- <summary>
- Sets the enumerator to its initial position, before the first element in the collection.
- </summary>
- </member>
- <member name="P:log4net.Plugin.PluginCollection.Enumerator.Current">
- <summary>
- Gets the current element in the collection.
- </summary>
- <value>
- The current element in the collection.
- </value>
- </member>
- <member name="T:log4net.Plugin.PluginCollection.ReadOnlyPluginCollection">
- <exclude/>
- </member>
- <member name="T:log4net.Plugin.PluginMap">
- <summary>
- Map of repository plugins.
- </summary>
- <remarks>
- <para>
- This class is a name keyed map of the plugins that are
- attached to a repository.
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- <author>Gert Driesen</author>
- </member>
- <member name="M:log4net.Plugin.PluginMap.#ctor(log4net.Repository.ILoggerRepository)">
- <summary>
- Constructor
- </summary>
- <param name="repository">The repository that the plugins should be attached to.</param>
- <remarks>
- <para>
- Initialize a new instance of the <see cref="T:log4net.Plugin.PluginMap"/> class with a
- repository that the plugins should be attached to.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Plugin.PluginMap.Add(log4net.Plugin.IPlugin)">
- <summary>
- Adds a <see cref="T:log4net.Plugin.IPlugin"/> to the map.
- </summary>
- <param name="plugin">The <see cref="T:log4net.Plugin.IPlugin"/> to add to the map.</param>
- <remarks>
- <para>
- The <see cref="T:log4net.Plugin.IPlugin"/> will be attached to the repository when added.
- </para>
- <para>
- If there already exists a plugin with the same name
- attached to the repository then the old plugin will
- be <see cref="M:log4net.Plugin.IPlugin.Shutdown"/> and replaced with
- the new plugin.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Plugin.PluginMap.Remove(log4net.Plugin.IPlugin)">
- <summary>
- Removes a <see cref="T:log4net.Plugin.IPlugin"/> from the map.
- </summary>
- <param name="plugin">The <see cref="T:log4net.Plugin.IPlugin"/> to remove from the map.</param>
- <remarks>
- <para>
- Remove a specific plugin from this map.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Plugin.PluginMap.Item(System.String)">
- <summary>
- Gets a <see cref="T:log4net.Plugin.IPlugin"/> by name.
- </summary>
- <param name="name">The name of the <see cref="T:log4net.Plugin.IPlugin"/> to lookup.</param>
- <returns>
- The <see cref="T:log4net.Plugin.IPlugin"/> from the map with the name specified, or
- <c>null</c> if no plugin is found.
- </returns>
- <remarks>
- <para>
- Lookup a plugin by name. If the plugin is not found <c>null</c>
- will be returned.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Plugin.PluginMap.AllPlugins">
- <summary>
- Gets all possible plugins as a list of <see cref="T:log4net.Plugin.IPlugin"/> objects.
- </summary>
- <value>All possible plugins as a list of <see cref="T:log4net.Plugin.IPlugin"/> objects.</value>
- <remarks>
- <para>
- Get a collection of all the plugins defined in this map.
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Plugin.PluginSkeleton">
- <summary>
- Base implementation of <see cref="T:log4net.Plugin.IPlugin"/>
- </summary>
- <remarks>
- <para>
- Default abstract implementation of the <see cref="T:log4net.Plugin.IPlugin"/>
- interface. This base class can be used by implementors
- of the <see cref="T:log4net.Plugin.IPlugin"/> interface.
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- <author>Gert Driesen</author>
- </member>
- <member name="M:log4net.Plugin.PluginSkeleton.#ctor(System.String)">
- <summary>
- Constructor
- </summary>
- <param name="name">the name of the plugin</param>
- <remarks>
- Initializes a new Plugin with the specified name.
- </remarks>
- </member>
- <member name="M:log4net.Plugin.PluginSkeleton.Attach(log4net.Repository.ILoggerRepository)">
- <summary>
- Attaches this plugin to a <see cref="T:log4net.Repository.ILoggerRepository"/>.
- </summary>
- <param name="repository">The <see cref="T:log4net.Repository.ILoggerRepository"/> that this plugin should be attached to.</param>
- <remarks>
- <para>
- A plugin may only be attached to a single repository.
- </para>
- <para>
- This method is called when the plugin is attached to the repository.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Plugin.PluginSkeleton.Shutdown">
- <summary>
- Is called when the plugin is to shutdown.
- </summary>
- <remarks>
- <para>
- This method is called to notify the plugin that
- it should stop operating and should detach from
- the repository.
- </para>
- </remarks>
- </member>
- <member name="F:log4net.Plugin.PluginSkeleton.m_name">
- <summary>
- The name of this plugin.
- </summary>
- </member>
- <member name="F:log4net.Plugin.PluginSkeleton.m_repository">
- <summary>
- The repository this plugin is attached to.
- </summary>
- </member>
- <member name="P:log4net.Plugin.PluginSkeleton.Name">
- <summary>
- Gets or sets the name of the plugin.
- </summary>
- <value>
- The name of the plugin.
- </value>
- <remarks>
- <para>
- Plugins are stored in the <see cref="T:log4net.Plugin.PluginMap"/>
- keyed by name. Each plugin instance attached to a
- repository must be a unique name.
- </para>
- <para>
- The name of the plugin must not change one the
- plugin has been attached to a repository.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Plugin.PluginSkeleton.LoggerRepository">
- <summary>
- The repository for this plugin
- </summary>
- <value>
- The <see cref="T:log4net.Repository.ILoggerRepository"/> that this plugin is attached to.
- </value>
- <remarks>
- <para>
- Gets or sets the <see cref="T:log4net.Repository.ILoggerRepository"/> that this plugin is
- attached to.
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Plugin.RemoteLoggingServerPlugin">
- <summary>
- Plugin that listens for events from the <see cref="T:log4net.Appender.RemotingAppender"/>
- </summary>
- <remarks>
- <para>
- This plugin publishes an instance of <see cref="T:log4net.Appender.RemotingAppender.IRemoteLoggingSink"/>
- on a specified <see cref="P:log4net.Plugin.RemoteLoggingServerPlugin.SinkUri"/>. This listens for logging events delivered from
- a remote <see cref="T:log4net.Appender.RemotingAppender"/>.
- </para>
- <para>
- When an event is received it is relogged within the attached repository
- as if it had been raised locally.
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- <author>Gert Driesen</author>
- </member>
- <member name="M:log4net.Plugin.RemoteLoggingServerPlugin.#ctor">
- <summary>
- Default constructor
- </summary>
- <remarks>
- <para>
- Initializes a new instance of the <see cref="T:log4net.Plugin.RemoteLoggingServerPlugin"/> class.
- </para>
- <para>
- The <see cref="P:log4net.Plugin.RemoteLoggingServerPlugin.SinkUri"/> property must be set.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Plugin.RemoteLoggingServerPlugin.#ctor(System.String)">
- <summary>
- Construct with sink Uri.
- </summary>
- <param name="sinkUri">The name to publish the sink under in the remoting infrastructure.
- See <see cref="P:log4net.Plugin.RemoteLoggingServerPlugin.SinkUri"/> for more details.</param>
- <remarks>
- <para>
- Initializes a new instance of the <see cref="T:log4net.Plugin.RemoteLoggingServerPlugin"/> class
- with specified name.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Plugin.RemoteLoggingServerPlugin.Attach(log4net.Repository.ILoggerRepository)">
- <summary>
- Attaches this plugin to a <see cref="T:log4net.Repository.ILoggerRepository"/>.
- </summary>
- <param name="repository">The <see cref="T:log4net.Repository.ILoggerRepository"/> that this plugin should be attached to.</param>
- <remarks>
- <para>
- A plugin may only be attached to a single repository.
- </para>
- <para>
- This method is called when the plugin is attached to the repository.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Plugin.RemoteLoggingServerPlugin.Shutdown">
- <summary>
- Is called when the plugin is to shutdown.
- </summary>
- <remarks>
- <para>
- When the plugin is shutdown the remote logging
- sink is disconnected.
- </para>
- </remarks>
- </member>
- <member name="F:log4net.Plugin.RemoteLoggingServerPlugin.declaringType">
- <summary>
- The fully qualified type of the RemoteLoggingServerPlugin class.
- </summary>
- <remarks>
- Used by the internal logger to record the Type of the
- log message.
- </remarks>
- </member>
- <member name="P:log4net.Plugin.RemoteLoggingServerPlugin.SinkUri">
- <summary>
- Gets or sets the URI of this sink.
- </summary>
- <value>
- The URI of this sink.
- </value>
- <remarks>
- <para>
- This is the name under which the object is marshaled.
- <see cref="M:RemotingServices.Marshal(MarshalByRefObject,String,Type)"/>
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Plugin.RemoteLoggingServerPlugin.RemoteLoggingSinkImpl">
- <summary>
- Delivers <see cref="T:log4net.Core.LoggingEvent"/> objects to a remote sink.
- </summary>
- <remarks>
- <para>
- Internal class used to listen for logging events
- and deliver them to the local repository.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Plugin.RemoteLoggingServerPlugin.RemoteLoggingSinkImpl.#ctor(log4net.Repository.ILoggerRepository)">
- <summary>
- Constructor
- </summary>
- <param name="repository">The repository to log to.</param>
- <remarks>
- <para>
- Initializes a new instance of the <see cref="T:log4net.Plugin.RemoteLoggingServerPlugin.RemoteLoggingSinkImpl"/> for the
- specified <see cref="T:log4net.Repository.ILoggerRepository"/>.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Plugin.RemoteLoggingServerPlugin.RemoteLoggingSinkImpl.LogEvents(log4net.Core.LoggingEvent[])">
- <summary>
- Logs the events to the repository.
- </summary>
- <param name="events">The events to log.</param>
- <remarks>
- <para>
- The events passed are logged to the <see cref="T:log4net.Repository.ILoggerRepository"/>
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Plugin.RemoteLoggingServerPlugin.RemoteLoggingSinkImpl.InitializeLifetimeService">
- <summary>
- Obtains a lifetime service object to control the lifetime
- policy for this instance.
- </summary>
- <returns><c>null</c> to indicate that this instance should live forever.</returns>
- <remarks>
- <para>
- Obtains a lifetime service object to control the lifetime
- policy for this instance. This object should live forever
- therefore this implementation returns <c>null</c>.
- </para>
- </remarks>
- </member>
- <member name="F:log4net.Plugin.RemoteLoggingServerPlugin.RemoteLoggingSinkImpl.m_repository">
- <summary>
- The underlying <see cref="T:log4net.Repository.ILoggerRepository"/> that events should
- be logged to.
- </summary>
- </member>
- <member name="T:log4net.Repository.Hierarchy.DefaultLoggerFactory">
- <summary>
- Default implementation of <see cref="T:log4net.Repository.Hierarchy.ILoggerFactory"/>
- </summary>
- <remarks>
- <para>
- This default implementation of the <see cref="T:log4net.Repository.Hierarchy.ILoggerFactory"/>
- interface is used to create the default subclass
- of the <see cref="T:log4net.Repository.Hierarchy.Logger"/> object.
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- <author>Gert Driesen</author>
- </member>
- <member name="T:log4net.Repository.Hierarchy.ILoggerFactory">
- <summary>
- Interface abstracts creation of <see cref="T:log4net.Repository.Hierarchy.Logger"/> instances
- </summary>
- <remarks>
- <para>
- This interface is used by the <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/> to
- create new <see cref="T:log4net.Repository.Hierarchy.Logger"/> objects.
- </para>
- <para>
- The <see cref="M:log4net.Repository.Hierarchy.ILoggerFactory.CreateLogger(log4net.Repository.ILoggerRepository,System.String)"/> method is called
- to create a named <see cref="T:log4net.Repository.Hierarchy.Logger"/>.
- </para>
- <para>
- Implement this interface to create new subclasses of <see cref="T:log4net.Repository.Hierarchy.Logger"/>.
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- <author>Gert Driesen</author>
- </member>
- <member name="M:log4net.Repository.Hierarchy.ILoggerFactory.CreateLogger(log4net.Repository.ILoggerRepository,System.String)">
- <summary>
- Create a new <see cref="T:log4net.Repository.Hierarchy.Logger"/> instance
- </summary>
- <param name="repository">The <see cref="T:log4net.Repository.ILoggerRepository"/> that will own the <see cref="T:log4net.Repository.Hierarchy.Logger"/>.</param>
- <param name="name">The name of the <see cref="T:log4net.Repository.Hierarchy.Logger"/>.</param>
- <returns>The <see cref="T:log4net.Repository.Hierarchy.Logger"/> instance for the specified name.</returns>
- <remarks>
- <para>
- Create a new <see cref="T:log4net.Repository.Hierarchy.Logger"/> instance with the
- specified name.
- </para>
- <para>
- Called by the <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/> to create
- new named <see cref="T:log4net.Repository.Hierarchy.Logger"/> instances.
- </para>
- <para>
- If the <paramref name="name"/> is <c>null</c> then the root logger
- must be returned.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Repository.Hierarchy.DefaultLoggerFactory.#ctor">
- <summary>
- Default constructor
- </summary>
- <remarks>
- <para>
- Initializes a new instance of the <see cref="T:log4net.Repository.Hierarchy.DefaultLoggerFactory"/> class.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Repository.Hierarchy.DefaultLoggerFactory.CreateLogger(log4net.Repository.ILoggerRepository,System.String)">
- <summary>
- Create a new <see cref="T:log4net.Repository.Hierarchy.Logger"/> instance
- </summary>
- <param name="repository">The <see cref="T:log4net.Repository.ILoggerRepository"/> that will own the <see cref="T:log4net.Repository.Hierarchy.Logger"/>.</param>
- <param name="name">The name of the <see cref="T:log4net.Repository.Hierarchy.Logger"/>.</param>
- <returns>The <see cref="T:log4net.Repository.Hierarchy.Logger"/> instance for the specified name.</returns>
- <remarks>
- <para>
- Create a new <see cref="T:log4net.Repository.Hierarchy.Logger"/> instance with the
- specified name.
- </para>
- <para>
- Called by the <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/> to create
- new named <see cref="T:log4net.Repository.Hierarchy.Logger"/> instances.
- </para>
- <para>
- If the <paramref name="name"/> is <c>null</c> then the root logger
- must be returned.
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Repository.Hierarchy.DefaultLoggerFactory.LoggerImpl">
- <summary>
- Default internal subclass of <see cref="T:log4net.Repository.Hierarchy.Logger"/>
- </summary>
- <remarks>
- <para>
- This subclass has no additional behavior over the
- <see cref="T:log4net.Repository.Hierarchy.Logger"/> class but does allow instances
- to be created.
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Repository.Hierarchy.Logger">
- <summary>
- Implementation of <see cref="T:log4net.Core.ILogger"/> used by <see cref="P:log4net.Repository.Hierarchy.Logger.Hierarchy"/>
- </summary>
- <remarks>
- <para>
- Internal class used to provide implementation of <see cref="T:log4net.Core.ILogger"/>
- interface. Applications should use <see cref="T:log4net.LogManager"/> to get
- logger instances.
- </para>
- <para>
- This is one of the central classes in the log4net implementation. One of the
- distinctive features of log4net are hierarchical loggers and their
- evaluation. The <see cref="P:log4net.Repository.Hierarchy.Logger.Hierarchy"/> organizes the <see cref="T:log4net.Repository.Hierarchy.Logger"/>
- instances into a rooted tree hierarchy.
- </para>
- <para>
- The <see cref="T:log4net.Repository.Hierarchy.Logger"/> class is abstract. Only concrete subclasses of
- <see cref="T:log4net.Repository.Hierarchy.Logger"/> can be created. The <see cref="T:log4net.Repository.Hierarchy.ILoggerFactory"/>
- is used to create instances of this type for the <see cref="P:log4net.Repository.Hierarchy.Logger.Hierarchy"/>.
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- <author>Gert Driesen</author>
- <author>Aspi Havewala</author>
- <author>Douglas de la Torre</author>
- </member>
- <member name="M:log4net.Repository.Hierarchy.Logger.#ctor(System.String)">
- <summary>
- This constructor created a new <see cref="T:log4net.Repository.Hierarchy.Logger"/> instance and
- sets its name.
- </summary>
- <param name="name">The name of the <see cref="T:log4net.Repository.Hierarchy.Logger"/>.</param>
- <remarks>
- <para>
- This constructor is protected and designed to be used by
- a subclass that is not abstract.
- </para>
- <para>
- Loggers are constructed by <see cref="T:log4net.Repository.Hierarchy.ILoggerFactory"/>
- objects. See <see cref="T:log4net.Repository.Hierarchy.DefaultLoggerFactory"/> for the default
- logger creator.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Repository.Hierarchy.Logger.AddAppender(log4net.Appender.IAppender)">
- <summary>
- Add <paramref name="newAppender"/> to the list of appenders of this
- Logger instance.
- </summary>
- <param name="newAppender">An appender to add to this logger</param>
- <remarks>
- <para>
- Add <paramref name="newAppender"/> to the list of appenders of this
- Logger instance.
- </para>
- <para>
- If <paramref name="newAppender"/> is already in the list of
- appenders, then it won't be added again.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Repository.Hierarchy.Logger.GetAppender(System.String)">
- <summary>
- Look for the appender named as <c>name</c>
- </summary>
- <param name="name">The name of the appender to lookup</param>
- <returns>The appender with the name specified, or <c>null</c>.</returns>
- <remarks>
- <para>
- Returns the named appender, or null if the appender is not found.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Repository.Hierarchy.Logger.RemoveAllAppenders">
- <summary>
- Remove all previously added appenders from this Logger instance.
- </summary>
- <remarks>
- <para>
- Remove all previously added appenders from this Logger instance.
- </para>
- <para>
- This is useful when re-reading configuration information.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Repository.Hierarchy.Logger.RemoveAppender(log4net.Appender.IAppender)">
- <summary>
- Remove the appender passed as parameter form the list of appenders.
- </summary>
- <param name="appender">The appender to remove</param>
- <returns>The appender removed from the list</returns>
- <remarks>
- <para>
- Remove the appender passed as parameter form the list of appenders.
- The appender removed is not closed.
- If you are discarding the appender you must call
- <see cref="M:log4net.Appender.IAppender.Close"/> on the appender removed.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Repository.Hierarchy.Logger.RemoveAppender(System.String)">
- <summary>
- Remove the appender passed as parameter form the list of appenders.
- </summary>
- <param name="name">The name of the appender to remove</param>
- <returns>The appender removed from the list</returns>
- <remarks>
- <para>
- Remove the named appender passed as parameter form the list of appenders.
- The appender removed is not closed.
- If you are discarding the appender you must call
- <see cref="M:log4net.Appender.IAppender.Close"/> on the appender removed.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Repository.Hierarchy.Logger.Log(System.Type,log4net.Core.Level,System.Object,System.Exception)">
- <summary>
- This generic form is intended to be used by wrappers.
- </summary>
- <param name="callerStackBoundaryDeclaringType">The declaring type of the method that is
- the stack boundary into the logging system for this call.</param>
- <param name="level">The level of the message to be logged.</param>
- <param name="message">The message object to log.</param>
- <param name="exception">The exception to log, including its stack trace.</param>
- <remarks>
- <para>
- Generate a logging event for the specified <paramref name="level"/> using
- the <paramref name="message"/> and <paramref name="exception"/>.
- </para>
- <para>
- This method must not throw any exception to the caller.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Repository.Hierarchy.Logger.Log(log4net.Core.LoggingEvent)">
- <summary>
- This is the most generic printing method that is intended to be used
- by wrappers.
- </summary>
- <param name="logEvent">The event being logged.</param>
- <remarks>
- <para>
- Logs the specified logging event through this logger.
- </para>
- <para>
- This method must not throw any exception to the caller.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Repository.Hierarchy.Logger.IsEnabledFor(log4net.Core.Level)">
- <summary>
- Checks if this logger is enabled for a given <see cref="P:log4net.Repository.Hierarchy.Logger.Level"/> passed as parameter.
- </summary>
- <param name="level">The level to check.</param>
- <returns>
- <c>true</c> if this logger is enabled for <c>level</c>, otherwise <c>false</c>.
- </returns>
- <remarks>
- <para>
- Test if this logger is going to log events of the specified <paramref name="level"/>.
- </para>
- <para>
- This method must not throw any exception to the caller.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Repository.Hierarchy.Logger.CallAppenders(log4net.Core.LoggingEvent)">
- <summary>
- Deliver the <see cref="T:log4net.Core.LoggingEvent"/> to the attached appenders.
- </summary>
- <param name="loggingEvent">The event to log.</param>
- <remarks>
- <para>
- Call the appenders in the hierarchy starting at
- <c>this</c>. If no appenders could be found, emit a
- warning.
- </para>
- <para>
- This method calls all the appenders inherited from the
- hierarchy circumventing any evaluation of whether to log or not
- to log the particular log request.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Repository.Hierarchy.Logger.CloseNestedAppenders">
- <summary>
- Closes all attached appenders implementing the <see cref="T:log4net.Core.IAppenderAttachable"/> interface.
- </summary>
- <remarks>
- <para>
- Used to ensure that the appenders are correctly shutdown.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Repository.Hierarchy.Logger.Log(log4net.Core.Level,System.Object,System.Exception)">
- <summary>
- This is the most generic printing method. This generic form is intended to be used by wrappers
- </summary>
- <param name="level">The level of the message to be logged.</param>
- <param name="message">The message object to log.</param>
- <param name="exception">The exception to log, including its stack trace.</param>
- <remarks>
- <para>
- Generate a logging event for the specified <paramref name="level"/> using
- the <paramref name="message"/>.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Repository.Hierarchy.Logger.ForcedLog(System.Type,log4net.Core.Level,System.Object,System.Exception)">
- <summary>
- Creates a new logging event and logs the event without further checks.
- </summary>
- <param name="callerStackBoundaryDeclaringType">The declaring type of the method that is
- the stack boundary into the logging system for this call.</param>
- <param name="level">The level of the message to be logged.</param>
- <param name="message">The message object to log.</param>
- <param name="exception">The exception to log, including its stack trace.</param>
- <remarks>
- <para>
- Generates a logging event and delivers it to the attached
- appenders.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Repository.Hierarchy.Logger.ForcedLog(log4net.Core.LoggingEvent)">
- <summary>
- Creates a new logging event and logs the event without further checks.
- </summary>
- <param name="logEvent">The event being logged.</param>
- <remarks>
- <para>
- Delivers the logging event to the attached appenders.
- </para>
- </remarks>
- </member>
- <member name="F:log4net.Repository.Hierarchy.Logger.declaringType">
- <summary>
- The fully qualified type of the Logger class.
- </summary>
- </member>
- <member name="F:log4net.Repository.Hierarchy.Logger.m_name">
- <summary>
- The name of this logger.
- </summary>
- </member>
- <member name="F:log4net.Repository.Hierarchy.Logger.m_level">
- <summary>
- The assigned level of this logger.
- </summary>
- <remarks>
- <para>
- The <c>level</c> variable need not be
- assigned a value in which case it is inherited
- form the hierarchy.
- </para>
- </remarks>
- </member>
- <member name="F:log4net.Repository.Hierarchy.Logger.m_parent">
- <summary>
- The parent of this logger.
- </summary>
- <remarks>
- <para>
- The parent of this logger.
- All loggers have at least one ancestor which is the root logger.
- </para>
- </remarks>
- </member>
- <member name="F:log4net.Repository.Hierarchy.Logger.m_hierarchy">
- <summary>
- Loggers need to know what Hierarchy they are in.
- </summary>
- <remarks>
- <para>
- Loggers need to know what Hierarchy they are in.
- The hierarchy that this logger is a member of is stored
- here.
- </para>
- </remarks>
- </member>
- <member name="F:log4net.Repository.Hierarchy.Logger.m_appenderAttachedImpl">
- <summary>
- Helper implementation of the <see cref="T:log4net.Core.IAppenderAttachable"/> interface
- </summary>
- </member>
- <member name="F:log4net.Repository.Hierarchy.Logger.m_additive">
- <summary>
- Flag indicating if child loggers inherit their parents appenders
- </summary>
- <remarks>
- <para>
- Additivity is set to true by default, that is children inherit
- the appenders of their ancestors by default. If this variable is
- set to <c>false</c> then the appenders found in the
- ancestors of this logger are not used. However, the children
- of this logger will inherit its appenders, unless the children
- have their additivity flag set to <c>false</c> too. See
- the user manual for more details.
- </para>
- </remarks>
- </member>
- <member name="F:log4net.Repository.Hierarchy.Logger.m_appenderLock">
- <summary>
- Lock to protect AppenderAttachedImpl variable m_appenderAttachedImpl
- </summary>
- </member>
- <member name="P:log4net.Repository.Hierarchy.Logger.Parent">
- <summary>
- Gets or sets the parent logger in the hierarchy.
- </summary>
- <value>
- The parent logger in the hierarchy.
- </value>
- <remarks>
- <para>
- Part of the Composite pattern that makes the hierarchy.
- The hierarchy is parent linked rather than child linked.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Repository.Hierarchy.Logger.Additivity">
- <summary>
- Gets or sets a value indicating if child loggers inherit their parent's appenders.
- </summary>
- <value>
- <c>true</c> if child loggers inherit their parent's appenders.
- </value>
- <remarks>
- <para>
- Additivity is set to <c>true</c> by default, that is children inherit
- the appenders of their ancestors by default. If this variable is
- set to <c>false</c> then the appenders found in the
- ancestors of this logger are not used. However, the children
- of this logger will inherit its appenders, unless the children
- have their additivity flag set to <c>false</c> too. See
- the user manual for more details.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Repository.Hierarchy.Logger.EffectiveLevel">
- <summary>
- Gets the effective level for this logger.
- </summary>
- <returns>The nearest level in the logger hierarchy.</returns>
- <remarks>
- <para>
- Starting from this logger, searches the logger hierarchy for a
- non-null level and returns it. Otherwise, returns the level of the
- root logger.
- </para>
- <para>The Logger class is designed so that this method executes as
- quickly as possible.</para>
- </remarks>
- </member>
- <member name="P:log4net.Repository.Hierarchy.Logger.Hierarchy">
- <summary>
- Gets or sets the <see cref="P:log4net.Repository.Hierarchy.Logger.Hierarchy"/> where this
- <c>Logger</c> instance is attached to.
- </summary>
- <value>The hierarchy that this logger belongs to.</value>
- <remarks>
- <para>
- This logger must be attached to a single <see cref="P:log4net.Repository.Hierarchy.Logger.Hierarchy"/>.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Repository.Hierarchy.Logger.Level">
- <summary>
- Gets or sets the assigned <see cref="P:log4net.Repository.Hierarchy.Logger.Level"/>, if any, for this Logger.
- </summary>
- <value>
- The <see cref="P:log4net.Repository.Hierarchy.Logger.Level"/> of this logger.
- </value>
- <remarks>
- <para>
- The assigned <see cref="P:log4net.Repository.Hierarchy.Logger.Level"/> can be <c>null</c>.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Repository.Hierarchy.Logger.Appenders">
- <summary>
- Get the appenders contained in this logger as an
- <see cref="T:System.Collections.ICollection"/>.
- </summary>
- <returns>A collection of the appenders in this logger</returns>
- <remarks>
- <para>
- Get the appenders contained in this logger as an
- <see cref="T:System.Collections.ICollection"/>. If no appenders
- can be found, then a <see cref="T:log4net.Util.EmptyCollection"/> is returned.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Repository.Hierarchy.Logger.Name">
- <summary>
- Gets the logger name.
- </summary>
- <value>
- The name of the logger.
- </value>
- <remarks>
- <para>
- The name of this logger
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Repository.Hierarchy.Logger.Repository">
- <summary>
- Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> where this
- <c>Logger</c> instance is attached to.
- </summary>
- <value>
- The <see cref="T:log4net.Repository.ILoggerRepository"/> that this logger belongs to.
- </value>
- <remarks>
- <para>
- Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> where this
- <c>Logger</c> instance is attached to.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Repository.Hierarchy.DefaultLoggerFactory.LoggerImpl.#ctor(System.String)">
- <summary>
- Construct a new Logger
- </summary>
- <param name="name">the name of the logger</param>
- <remarks>
- <para>
- Initializes a new instance of the <see cref="T:log4net.Repository.Hierarchy.DefaultLoggerFactory.LoggerImpl"/> class
- with the specified name.
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Repository.Hierarchy.LoggerCreationEventHandler">
- <summary>
- Delegate used to handle logger creation event notifications.
- </summary>
- <param name="sender">The <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/> in which the <see cref="T:log4net.Repository.Hierarchy.Logger"/> has been created.</param>
- <param name="e">The <see cref="T:log4net.Repository.Hierarchy.LoggerCreationEventArgs"/> event args that hold the <see cref="T:log4net.Repository.Hierarchy.Logger"/> instance that has been created.</param>
- <remarks>
- <para>
- Delegate used to handle logger creation event notifications.
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Repository.Hierarchy.LoggerCreationEventArgs">
- <summary>
- Provides data for the <see cref="E:log4net.Repository.Hierarchy.Hierarchy.LoggerCreatedEvent"/> event.
- </summary>
- <remarks>
- <para>
- A <see cref="E:log4net.Repository.Hierarchy.Hierarchy.LoggerCreatedEvent"/> event is raised every time a
- <see cref="P:log4net.Repository.Hierarchy.LoggerCreationEventArgs.Logger"/> is created.
- </para>
- </remarks>
- </member>
- <member name="F:log4net.Repository.Hierarchy.LoggerCreationEventArgs.m_log">
- <summary>
- The <see cref="P:log4net.Repository.Hierarchy.LoggerCreationEventArgs.Logger"/> created
- </summary>
- </member>
- <member name="M:log4net.Repository.Hierarchy.LoggerCreationEventArgs.#ctor(log4net.Repository.Hierarchy.Logger)">
- <summary>
- Constructor
- </summary>
- <param name="log">The <see cref="P:log4net.Repository.Hierarchy.LoggerCreationEventArgs.Logger"/> that has been created.</param>
- <remarks>
- <para>
- Initializes a new instance of the <see cref="T:log4net.Repository.Hierarchy.LoggerCreationEventArgs"/> event argument
- class,with the specified <see cref="P:log4net.Repository.Hierarchy.LoggerCreationEventArgs.Logger"/>.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Repository.Hierarchy.LoggerCreationEventArgs.Logger">
- <summary>
- Gets the <see cref="P:log4net.Repository.Hierarchy.LoggerCreationEventArgs.Logger"/> that has been created.
- </summary>
- <value>
- The <see cref="P:log4net.Repository.Hierarchy.LoggerCreationEventArgs.Logger"/> that has been created.
- </value>
- <remarks>
- <para>
- The <see cref="P:log4net.Repository.Hierarchy.LoggerCreationEventArgs.Logger"/> that has been created.
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Repository.Hierarchy.Hierarchy">
- <summary>
- Hierarchical organization of loggers
- </summary>
- <remarks>
- <para>
- <i>The casual user should not have to deal with this class
- directly.</i>
- </para>
- <para>
- This class is specialized in retrieving loggers by name and
- also maintaining the logger hierarchy. Implements the
- <see cref="T:log4net.Repository.ILoggerRepository"/> interface.
- </para>
- <para>
- The structure of the logger hierarchy is maintained by the
- <see cref="M:GetLogger(string)"/> method. The hierarchy is such that children
- link to their parent but parents do not have any references to their
- children. Moreover, loggers can be instantiated in any order, in
- particular descendant before ancestor.
- </para>
- <para>
- In case a descendant is created before a particular ancestor,
- then it creates a provision node for the ancestor and adds itself
- to the provision node. Other descendants of the same ancestor add
- themselves to the previously created provision node.
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- <author>Gert Driesen</author>
- </member>
- <member name="T:log4net.Repository.LoggerRepositorySkeleton">
- <summary>
- Base implementation of <see cref="T:log4net.Repository.ILoggerRepository"/>
- </summary>
- <remarks>
- <para>
- Default abstract implementation of the <see cref="T:log4net.Repository.ILoggerRepository"/> interface.
- </para>
- <para>
- Skeleton implementation of the <see cref="T:log4net.Repository.ILoggerRepository"/> interface.
- All <see cref="T:log4net.Repository.ILoggerRepository"/> types can extend this type.
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- <author>Gert Driesen</author>
- </member>
- <member name="T:log4net.Repository.ILoggerRepository">
- <summary>
- Interface implemented by logger repositories.
- </summary>
- <remarks>
- <para>
- This interface is implemented by logger repositories. e.g.
- <see cref="N:log4net.Repository.Hierarchy"/>.
- </para>
- <para>
- This interface is used by the <see cref="T:log4net.LogManager"/>
- to obtain <see cref="T:log4net.ILog"/> interfaces.
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- <author>Gert Driesen</author>
- </member>
- <member name="M:log4net.Repository.ILoggerRepository.Exists(System.String)">
- <summary>
- Check if the named logger exists in the repository. If so return
- its reference, otherwise returns <c>null</c>.
- </summary>
- <param name="name">The name of the logger to lookup</param>
- <returns>The Logger object with the name specified</returns>
- <remarks>
- <para>
- If the names logger exists it is returned, otherwise
- <c>null</c> is returned.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Repository.ILoggerRepository.GetCurrentLoggers">
- <summary>
- Returns all the currently defined loggers as an Array.
- </summary>
- <returns>All the defined loggers</returns>
- <remarks>
- <para>
- Returns all the currently defined loggers as an Array.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Repository.ILoggerRepository.GetLogger(System.String)">
- <summary>
- Returns a named logger instance
- </summary>
- <param name="name">The name of the logger to retrieve</param>
- <returns>The logger object with the name specified</returns>
- <remarks>
- <para>
- Returns a named logger instance.
- </para>
- <para>
- If a logger of that name already exists, then it will be
- returned. Otherwise, a new logger will be instantiated and
- then linked with its existing ancestors as well as children.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Repository.ILoggerRepository.Shutdown">
- <summary>Shutdown the repository</summary>
- <remarks>
- <para>
- Shutting down a repository will <i>safely</i> close and remove
- all appenders in all loggers including the root logger.
- </para>
- <para>
- Some appenders need to be closed before the
- application exists. Otherwise, pending logging events might be
- lost.
- </para>
- <para>
- The <see cref="M:Shutdown()"/> method is careful to close nested
- appenders before closing regular appenders. This is allows
- configurations where a regular appender is attached to a logger
- and again to a nested appender.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Repository.ILoggerRepository.ResetConfiguration">
- <summary>
- Reset the repositories configuration to a default state
- </summary>
- <remarks>
- <para>
- Reset all values contained in this instance to their
- default state.
- </para>
- <para>
- Existing loggers are not removed. They are just reset.
- </para>
- <para>
- This method should be used sparingly and with care as it will
- block all logging until it is completed.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Repository.ILoggerRepository.Log(log4net.Core.LoggingEvent)">
- <summary>
- Log the <see cref="T:log4net.Core.LoggingEvent"/> through this repository.
- </summary>
- <param name="logEvent">the event to log</param>
- <remarks>
- <para>
- This method should not normally be used to log.
- The <see cref="T:log4net.ILog"/> interface should be used
- for routine logging. This interface can be obtained
- using the <see cref="M:log4net.LogManager.GetLogger(string)"/> method.
- </para>
- <para>
- The <c>logEvent</c> is delivered to the appropriate logger and
- that logger is then responsible for logging the event.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Repository.ILoggerRepository.GetAppenders">
- <summary>
- Returns all the Appenders that are configured as an Array.
- </summary>
- <returns>All the Appenders</returns>
- <remarks>
- <para>
- Returns all the Appenders that are configured as an Array.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Repository.ILoggerRepository.Name">
- <summary>
- The name of the repository
- </summary>
- <value>
- The name of the repository
- </value>
- <remarks>
- <para>
- The name of the repository.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Repository.ILoggerRepository.RendererMap">
- <summary>
- RendererMap accesses the object renderer map for this repository.
- </summary>
- <value>
- RendererMap accesses the object renderer map for this repository.
- </value>
- <remarks>
- <para>
- RendererMap accesses the object renderer map for this repository.
- </para>
- <para>
- The RendererMap holds a mapping between types and
- <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/> objects.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Repository.ILoggerRepository.PluginMap">
- <summary>
- The plugin map for this repository.
- </summary>
- <value>
- The plugin map for this repository.
- </value>
- <remarks>
- <para>
- The plugin map holds the <see cref="T:log4net.Plugin.IPlugin"/> instances
- that have been attached to this repository.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Repository.ILoggerRepository.LevelMap">
- <summary>
- Get the level map for the Repository.
- </summary>
- <remarks>
- <para>
- Get the level map for the Repository.
- </para>
- <para>
- The level map defines the mappings between
- level names and <see cref="T:log4net.Core.Level"/> objects in
- this repository.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Repository.ILoggerRepository.Threshold">
- <summary>
- The threshold for all events in this repository
- </summary>
- <value>
- The threshold for all events in this repository
- </value>
- <remarks>
- <para>
- The threshold for all events in this repository.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Repository.ILoggerRepository.Configured">
- <summary>
- Flag indicates if this repository has been configured.
- </summary>
- <value>
- Flag indicates if this repository has been configured.
- </value>
- <remarks>
- <para>
- Flag indicates if this repository has been configured.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Repository.ILoggerRepository.ConfigurationMessages">
- <summary>
- Collection of internal messages captured during the most
- recent configuration process.
- </summary>
- </member>
- <member name="E:log4net.Repository.ILoggerRepository.ShutdownEvent">
- <summary>
- Event to notify that the repository has been shutdown.
- </summary>
- <value>
- Event to notify that the repository has been shutdown.
- </value>
- <remarks>
- <para>
- Event raised when the repository has been shutdown.
- </para>
- </remarks>
- </member>
- <member name="E:log4net.Repository.ILoggerRepository.ConfigurationReset">
- <summary>
- Event to notify that the repository has had its configuration reset.
- </summary>
- <value>
- Event to notify that the repository has had its configuration reset.
- </value>
- <remarks>
- <para>
- Event raised when the repository's configuration has been
- reset to default.
- </para>
- </remarks>
- </member>
- <member name="E:log4net.Repository.ILoggerRepository.ConfigurationChanged">
- <summary>
- Event to notify that the repository has had its configuration changed.
- </summary>
- <value>
- Event to notify that the repository has had its configuration changed.
- </value>
- <remarks>
- <para>
- Event raised when the repository's configuration has been changed.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Repository.ILoggerRepository.Properties">
- <summary>
- Repository specific properties
- </summary>
- <value>
- Repository specific properties
- </value>
- <remarks>
- <para>
- These properties can be specified on a repository specific basis.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Repository.LoggerRepositorySkeleton.#ctor">
- <summary>
- Default Constructor
- </summary>
- <remarks>
- <para>
- Initializes the repository with default (empty) properties.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Repository.LoggerRepositorySkeleton.#ctor(log4net.Util.PropertiesDictionary)">
- <summary>
- Construct the repository using specific properties
- </summary>
- <param name="properties">the properties to set for this repository</param>
- <remarks>
- <para>
- Initializes the repository with specified properties.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Repository.LoggerRepositorySkeleton.Exists(System.String)">
- <summary>
- Test if logger exists
- </summary>
- <param name="name">The name of the logger to lookup</param>
- <returns>The Logger object with the name specified</returns>
- <remarks>
- <para>
- Check if the named logger exists in the repository. If so return
- its reference, otherwise returns <c>null</c>.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Repository.LoggerRepositorySkeleton.GetCurrentLoggers">
- <summary>
- Returns all the currently defined loggers in the repository
- </summary>
- <returns>All the defined loggers</returns>
- <remarks>
- <para>
- Returns all the currently defined loggers in the repository as an Array.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Repository.LoggerRepositorySkeleton.GetLogger(System.String)">
- <summary>
- Return a new logger instance
- </summary>
- <param name="name">The name of the logger to retrieve</param>
- <returns>The logger object with the name specified</returns>
- <remarks>
- <para>
- Return a new logger instance.
- </para>
- <para>
- If a logger of that name already exists, then it will be
- returned. Otherwise, a new logger will be instantiated and
- then linked with its existing ancestors as well as children.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Repository.LoggerRepositorySkeleton.Shutdown">
- <summary>
- Shutdown the repository
- </summary>
- <remarks>
- <para>
- Shutdown the repository. Can be overridden in a subclass.
- This base class implementation notifies the <see cref="E:log4net.Repository.LoggerRepositorySkeleton.ShutdownEvent"/>
- listeners and all attached plugins of the shutdown event.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Repository.LoggerRepositorySkeleton.ResetConfiguration">
- <summary>
- Reset the repositories configuration to a default state
- </summary>
- <remarks>
- <para>
- Reset all values contained in this instance to their
- default state.
- </para>
- <para>
- Existing loggers are not removed. They are just reset.
- </para>
- <para>
- This method should be used sparingly and with care as it will
- block all logging until it is completed.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Repository.LoggerRepositorySkeleton.Log(log4net.Core.LoggingEvent)">
- <summary>
- Log the logEvent through this repository.
- </summary>
- <param name="logEvent">the event to log</param>
- <remarks>
- <para>
- This method should not normally be used to log.
- The <see cref="T:log4net.ILog"/> interface should be used
- for routine logging. This interface can be obtained
- using the <see cref="M:log4net.LogManager.GetLogger(string)"/> method.
- </para>
- <para>
- The <c>logEvent</c> is delivered to the appropriate logger and
- that logger is then responsible for logging the event.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Repository.LoggerRepositorySkeleton.GetAppenders">
- <summary>
- Returns all the Appenders that are configured as an Array.
- </summary>
- <returns>All the Appenders</returns>
- <remarks>
- <para>
- Returns all the Appenders that are configured as an Array.
- </para>
- </remarks>
- </member>
- <member name="F:log4net.Repository.LoggerRepositorySkeleton.declaringType">
- <summary>
- The fully qualified type of the LoggerRepositorySkeleton class.
- </summary>
- <remarks>
- Used by the internal logger to record the Type of the
- log message.
- </remarks>
- </member>
- <member name="M:log4net.Repository.LoggerRepositorySkeleton.AddRenderer(System.Type,log4net.ObjectRenderer.IObjectRenderer)">
- <summary>
- Adds an object renderer for a specific class.
- </summary>
- <param name="typeToRender">The type that will be rendered by the renderer supplied.</param>
- <param name="rendererInstance">The object renderer used to render the object.</param>
- <remarks>
- <para>
- Adds an object renderer for a specific class.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Repository.LoggerRepositorySkeleton.OnShutdown(System.EventArgs)">
- <summary>
- Notify the registered listeners that the repository is shutting down
- </summary>
- <param name="e">Empty EventArgs</param>
- <remarks>
- <para>
- Notify any listeners that this repository is shutting down.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Repository.LoggerRepositorySkeleton.OnConfigurationReset(System.EventArgs)">
- <summary>
- Notify the registered listeners that the repository has had its configuration reset
- </summary>
- <param name="e">Empty EventArgs</param>
- <remarks>
- <para>
- Notify any listeners that this repository's configuration has been reset.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Repository.LoggerRepositorySkeleton.OnConfigurationChanged(System.EventArgs)">
- <summary>
- Notify the registered listeners that the repository has had its configuration changed
- </summary>
- <param name="e">Empty EventArgs</param>
- <remarks>
- <para>
- Notify any listeners that this repository's configuration has changed.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Repository.LoggerRepositorySkeleton.RaiseConfigurationChanged(System.EventArgs)">
- <summary>
- Raise a configuration changed event on this repository
- </summary>
- <param name="e">EventArgs.Empty</param>
- <remarks>
- <para>
- Applications that programmatically change the configuration of the repository should
- raise this event notification to notify listeners.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Repository.LoggerRepositorySkeleton.Name">
- <summary>
- The name of the repository
- </summary>
- <value>
- The string name of the repository
- </value>
- <remarks>
- <para>
- The name of this repository. The name is
- used to store and lookup the repositories
- stored by the <see cref="T:log4net.Core.IRepositorySelector"/>.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Repository.LoggerRepositorySkeleton.Threshold">
- <summary>
- The threshold for all events in this repository
- </summary>
- <value>
- The threshold for all events in this repository
- </value>
- <remarks>
- <para>
- The threshold for all events in this repository
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Repository.LoggerRepositorySkeleton.RendererMap">
- <summary>
- RendererMap accesses the object renderer map for this repository.
- </summary>
- <value>
- RendererMap accesses the object renderer map for this repository.
- </value>
- <remarks>
- <para>
- RendererMap accesses the object renderer map for this repository.
- </para>
- <para>
- The RendererMap holds a mapping between types and
- <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/> objects.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Repository.LoggerRepositorySkeleton.PluginMap">
- <summary>
- The plugin map for this repository.
- </summary>
- <value>
- The plugin map for this repository.
- </value>
- <remarks>
- <para>
- The plugin map holds the <see cref="T:log4net.Plugin.IPlugin"/> instances
- that have been attached to this repository.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Repository.LoggerRepositorySkeleton.LevelMap">
- <summary>
- Get the level map for the Repository.
- </summary>
- <remarks>
- <para>
- Get the level map for the Repository.
- </para>
- <para>
- The level map defines the mappings between
- level names and <see cref="T:log4net.Core.Level"/> objects in
- this repository.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Repository.LoggerRepositorySkeleton.Configured">
- <summary>
- Flag indicates if this repository has been configured.
- </summary>
- <value>
- Flag indicates if this repository has been configured.
- </value>
- <remarks>
- <para>
- Flag indicates if this repository has been configured.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Repository.LoggerRepositorySkeleton.ConfigurationMessages">
- <summary>
- Contains a list of internal messages captures during the
- last configuration.
- </summary>
- </member>
- <member name="E:log4net.Repository.LoggerRepositorySkeleton.ShutdownEvent">
- <summary>
- Event to notify that the repository has been shutdown.
- </summary>
- <value>
- Event to notify that the repository has been shutdown.
- </value>
- <remarks>
- <para>
- Event raised when the repository has been shutdown.
- </para>
- </remarks>
- </member>
- <member name="E:log4net.Repository.LoggerRepositorySkeleton.ConfigurationReset">
- <summary>
- Event to notify that the repository has had its configuration reset.
- </summary>
- <value>
- Event to notify that the repository has had its configuration reset.
- </value>
- <remarks>
- <para>
- Event raised when the repository's configuration has been
- reset to default.
- </para>
- </remarks>
- </member>
- <member name="E:log4net.Repository.LoggerRepositorySkeleton.ConfigurationChanged">
- <summary>
- Event to notify that the repository has had its configuration changed.
- </summary>
- <value>
- Event to notify that the repository has had its configuration changed.
- </value>
- <remarks>
- <para>
- Event raised when the repository's configuration has been changed.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Repository.LoggerRepositorySkeleton.Properties">
- <summary>
- Repository specific properties
- </summary>
- <value>
- Repository specific properties
- </value>
- <remarks>
- These properties can be specified on a repository specific basis
- </remarks>
- </member>
- <member name="T:log4net.Repository.IBasicRepositoryConfigurator">
- <summary>
- Basic Configurator interface for repositories
- </summary>
- <remarks>
- <para>
- Interface used by basic configurator to configure a <see cref="T:log4net.Repository.ILoggerRepository"/>
- with a default <see cref="T:log4net.Appender.IAppender"/>.
- </para>
- <para>
- A <see cref="T:log4net.Repository.ILoggerRepository"/> should implement this interface to support
- configuration by the <see cref="T:log4net.Config.BasicConfigurator"/>.
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- <author>Gert Driesen</author>
- </member>
- <member name="M:log4net.Repository.IBasicRepositoryConfigurator.Configure(log4net.Appender.IAppender)">
- <summary>
- Initialize the repository using the specified appender
- </summary>
- <param name="appender">the appender to use to log all logging events</param>
- <remarks>
- <para>
- Configure the repository to route all logging events to the
- specified appender.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Repository.IBasicRepositoryConfigurator.Configure(log4net.Appender.IAppender[])">
- <summary>
- Initialize the repository using the specified appenders
- </summary>
- <param name="appenders">the appenders to use to log all logging events</param>
- <remarks>
- <para>
- Configure the repository to route all logging events to the
- specified appenders.
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Repository.IXmlRepositoryConfigurator">
- <summary>
- Configure repository using XML
- </summary>
- <remarks>
- <para>
- Interface used by Xml configurator to configure a <see cref="T:log4net.Repository.ILoggerRepository"/>.
- </para>
- <para>
- A <see cref="T:log4net.Repository.ILoggerRepository"/> should implement this interface to support
- configuration by the <see cref="T:log4net.Config.XmlConfigurator"/>.
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- <author>Gert Driesen</author>
- </member>
- <member name="M:log4net.Repository.IXmlRepositoryConfigurator.Configure(System.Xml.XmlElement)">
- <summary>
- Initialize the repository using the specified config
- </summary>
- <param name="element">the element containing the root of the config</param>
- <remarks>
- <para>
- The schema for the XML configuration data is defined by
- the implementation.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Repository.Hierarchy.Hierarchy.#ctor">
- <summary>
- Default constructor
- </summary>
- <remarks>
- <para>
- Initializes a new instance of the <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/> class.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Repository.Hierarchy.Hierarchy.#ctor(log4net.Util.PropertiesDictionary)">
- <summary>
- Construct with properties
- </summary>
- <param name="properties">The properties to pass to this repository.</param>
- <remarks>
- <para>
- Initializes a new instance of the <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/> class.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Repository.Hierarchy.Hierarchy.#ctor(log4net.Repository.Hierarchy.ILoggerFactory)">
- <summary>
- Construct with a logger factory
- </summary>
- <param name="loggerFactory">The factory to use to create new logger instances.</param>
- <remarks>
- <para>
- Initializes a new instance of the <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/> class with
- the specified <see cref="T:log4net.Repository.Hierarchy.ILoggerFactory"/>.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Repository.Hierarchy.Hierarchy.#ctor(log4net.Util.PropertiesDictionary,log4net.Repository.Hierarchy.ILoggerFactory)">
- <summary>
- Construct with properties and a logger factory
- </summary>
- <param name="properties">The properties to pass to this repository.</param>
- <param name="loggerFactory">The factory to use to create new logger instances.</param>
- <remarks>
- <para>
- Initializes a new instance of the <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/> class with
- the specified <see cref="T:log4net.Repository.Hierarchy.ILoggerFactory"/>.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Repository.Hierarchy.Hierarchy.Exists(System.String)">
- <summary>
- Test if a logger exists
- </summary>
- <param name="name">The name of the logger to lookup</param>
- <returns>The Logger object with the name specified</returns>
- <remarks>
- <para>
- Check if the named logger exists in the hierarchy. If so return
- its reference, otherwise returns <c>null</c>.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Repository.Hierarchy.Hierarchy.GetCurrentLoggers">
- <summary>
- Returns all the currently defined loggers in the hierarchy as an Array
- </summary>
- <returns>All the defined loggers</returns>
- <remarks>
- <para>
- Returns all the currently defined loggers in the hierarchy as an Array.
- The root logger is <b>not</b> included in the returned
- enumeration.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Repository.Hierarchy.Hierarchy.GetLogger(System.String)">
- <summary>
- Return a new logger instance named as the first parameter using
- the default factory.
- </summary>
- <remarks>
- <para>
- Return a new logger instance named as the first parameter using
- the default factory.
- </para>
- <para>
- If a logger of that name already exists, then it will be
- returned. Otherwise, a new logger will be instantiated and
- then linked with its existing ancestors as well as children.
- </para>
- </remarks>
- <param name="name">The name of the logger to retrieve</param>
- <returns>The logger object with the name specified</returns>
- </member>
- <member name="M:log4net.Repository.Hierarchy.Hierarchy.Shutdown">
- <summary>
- Shutting down a hierarchy will <i>safely</i> close and remove
- all appenders in all loggers including the root logger.
- </summary>
- <remarks>
- <para>
- Shutting down a hierarchy will <i>safely</i> close and remove
- all appenders in all loggers including the root logger.
- </para>
- <para>
- Some appenders need to be closed before the
- application exists. Otherwise, pending logging events might be
- lost.
- </para>
- <para>
- The <c>Shutdown</c> method is careful to close nested
- appenders before closing regular appenders. This is allows
- configurations where a regular appender is attached to a logger
- and again to a nested appender.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Repository.Hierarchy.Hierarchy.ResetConfiguration">
- <summary>
- Reset all values contained in this hierarchy instance to their default.
- </summary>
- <remarks>
- <para>
- Reset all values contained in this hierarchy instance to their
- default. This removes all appenders from all loggers, sets
- the level of all non-root loggers to <c>null</c>,
- sets their additivity flag to <c>true</c> and sets the level
- of the root logger to <see cref="F:log4net.Core.Level.Debug"/>. Moreover,
- message disabling is set its default "off" value.
- </para>
- <para>
- Existing loggers are not removed. They are just reset.
- </para>
- <para>
- This method should be used sparingly and with care as it will
- block all logging until it is completed.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Repository.Hierarchy.Hierarchy.Log(log4net.Core.LoggingEvent)">
- <summary>
- Log the logEvent through this hierarchy.
- </summary>
- <param name="logEvent">the event to log</param>
- <remarks>
- <para>
- This method should not normally be used to log.
- The <see cref="T:log4net.ILog"/> interface should be used
- for routine logging. This interface can be obtained
- using the <see cref="M:log4net.LogManager.GetLogger(string)"/> method.
- </para>
- <para>
- The <c>logEvent</c> is delivered to the appropriate logger and
- that logger is then responsible for logging the event.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Repository.Hierarchy.Hierarchy.GetAppenders">
- <summary>
- Returns all the Appenders that are currently configured
- </summary>
- <returns>An array containing all the currently configured appenders</returns>
- <remarks>
- <para>
- Returns all the <see cref="T:log4net.Appender.IAppender"/> instances that are currently configured.
- All the loggers are searched for appenders. The appenders may also be containers
- for appenders and these are also searched for additional loggers.
- </para>
- <para>
- The list returned is unordered but does not contain duplicates.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Repository.Hierarchy.Hierarchy.CollectAppender(System.Collections.ArrayList,log4net.Appender.IAppender)">
- <summary>
- Collect the appenders from an <see cref="T:log4net.Core.IAppenderAttachable"/>.
- The appender may also be a container.
- </summary>
- <param name="appenderList"></param>
- <param name="appender"></param>
- </member>
- <member name="M:log4net.Repository.Hierarchy.Hierarchy.CollectAppenders(System.Collections.ArrayList,log4net.Core.IAppenderAttachable)">
- <summary>
- Collect the appenders from an <see cref="T:log4net.Core.IAppenderAttachable"/> container
- </summary>
- <param name="appenderList"></param>
- <param name="container"></param>
- </member>
- <member name="M:log4net.Repository.Hierarchy.Hierarchy.log4net#Repository#IBasicRepositoryConfigurator#Configure(log4net.Appender.IAppender)">
- <summary>
- Initialize the log4net system using the specified appender
- </summary>
- <param name="appender">the appender to use to log all logging events</param>
- </member>
- <member name="M:log4net.Repository.Hierarchy.Hierarchy.log4net#Repository#IBasicRepositoryConfigurator#Configure(log4net.Appender.IAppender[])">
- <summary>
- Initialize the log4net system using the specified appenders
- </summary>
- <param name="appenders">the appenders to use to log all logging events</param>
- </member>
- <member name="M:log4net.Repository.Hierarchy.Hierarchy.BasicRepositoryConfigure(log4net.Appender.IAppender[])">
- <summary>
- Initialize the log4net system using the specified appenders
- </summary>
- <param name="appenders">the appenders to use to log all logging events</param>
- <remarks>
- <para>
- This method provides the same functionality as the
- <see cref="M:IBasicRepositoryConfigurator.Configure(IAppender)"/> method implemented
- on this object, but it is protected and therefore can be called by subclasses.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Repository.Hierarchy.Hierarchy.log4net#Repository#IXmlRepositoryConfigurator#Configure(System.Xml.XmlElement)">
- <summary>
- Initialize the log4net system using the specified config
- </summary>
- <param name="element">the element containing the root of the config</param>
- </member>
- <member name="M:log4net.Repository.Hierarchy.Hierarchy.XmlRepositoryConfigure(System.Xml.XmlElement)">
- <summary>
- Initialize the log4net system using the specified config
- </summary>
- <param name="element">the element containing the root of the config</param>
- <remarks>
- <para>
- This method provides the same functionality as the
- <see cref="M:IBasicRepositoryConfigurator.Configure(IAppender)"/> method implemented
- on this object, but it is protected and therefore can be called by subclasses.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Repository.Hierarchy.Hierarchy.IsDisabled(log4net.Core.Level)">
- <summary>
- Test if this hierarchy is disabled for the specified <see cref="T:log4net.Core.Level"/>.
- </summary>
- <param name="level">The level to check against.</param>
- <returns>
- <c>true</c> if the repository is disabled for the level argument, <c>false</c> otherwise.
- </returns>
- <remarks>
- <para>
- If this hierarchy has not been configured then this method will
- always return <c>true</c>.
- </para>
- <para>
- This method will return <c>true</c> if this repository is
- disabled for <c>level</c> object passed as parameter and
- <c>false</c> otherwise.
- </para>
- <para>
- See also the <see cref="P:log4net.Repository.ILoggerRepository.Threshold"/> property.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Repository.Hierarchy.Hierarchy.Clear">
- <summary>
- Clear all logger definitions from the internal hashtable
- </summary>
- <remarks>
- <para>
- This call will clear all logger definitions from the internal
- hashtable. Invoking this method will irrevocably mess up the
- logger hierarchy.
- </para>
- <para>
- You should <b>really</b> know what you are doing before
- invoking this method.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Repository.Hierarchy.Hierarchy.GetLogger(System.String,log4net.Repository.Hierarchy.ILoggerFactory)">
- <summary>
- Return a new logger instance named as the first parameter using
- <paramref name="factory"/>.
- </summary>
- <param name="name">The name of the logger to retrieve</param>
- <param name="factory">The factory that will make the new logger instance</param>
- <returns>The logger object with the name specified</returns>
- <remarks>
- <para>
- If a logger of that name already exists, then it will be
- returned. Otherwise, a new logger will be instantiated by the
- <paramref name="factory"/> parameter and linked with its existing
- ancestors as well as children.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Repository.Hierarchy.Hierarchy.OnLoggerCreationEvent(log4net.Repository.Hierarchy.Logger)">
- <summary>
- Sends a logger creation event to all registered listeners
- </summary>
- <param name="logger">The newly created logger</param>
- <remarks>
- Raises the logger creation event.
- </remarks>
- </member>
- <member name="M:log4net.Repository.Hierarchy.Hierarchy.UpdateParents(log4net.Repository.Hierarchy.Logger)">
- <summary>
- Updates all the parents of the specified logger
- </summary>
- <param name="log">The logger to update the parents for</param>
- <remarks>
- <para>
- This method loops through all the <i>potential</i> parents of
- <paramref name="log"/>. There 3 possible cases:
- </para>
- <list type="number">
- <item>
- <term>No entry for the potential parent of <paramref name="log"/> exists</term>
- <description>
- We create a ProvisionNode for this potential
- parent and insert <paramref name="log"/> in that provision node.
- </description>
- </item>
- <item>
- <term>The entry is of type Logger for the potential parent.</term>
- <description>
- The entry is <paramref name="log"/>'s nearest existing parent. We
- update <paramref name="log"/>'s parent field with this entry. We also break from
- he loop because updating our parent's parent is our parent's
- responsibility.
- </description>
- </item>
- <item>
- <term>The entry is of type ProvisionNode for this potential parent.</term>
- <description>
- We add <paramref name="log"/> to the list of children for this
- potential parent.
- </description>
- </item>
- </list>
- </remarks>
- </member>
- <member name="M:log4net.Repository.Hierarchy.Hierarchy.UpdateChildren(log4net.Repository.Hierarchy.ProvisionNode,log4net.Repository.Hierarchy.Logger)">
- <summary>
- Replace a <see cref="T:log4net.Repository.Hierarchy.ProvisionNode"/> with a <see cref="T:log4net.Repository.Hierarchy.Logger"/> in the hierarchy.
- </summary>
- <param name="pn"></param>
- <param name="log"></param>
- <remarks>
- <para>
- We update the links for all the children that placed themselves
- in the provision node 'pn'. The second argument 'log' is a
- reference for the newly created Logger, parent of all the
- children in 'pn'.
- </para>
- <para>
- We loop on all the children 'c' in 'pn'.
- </para>
- <para>
- If the child 'c' has been already linked to a child of
- 'log' then there is no need to update 'c'.
- </para>
- <para>
- Otherwise, we set log's parent field to c's parent and set
- c's parent field to log.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Repository.Hierarchy.Hierarchy.AddLevel(log4net.Repository.Hierarchy.Hierarchy.LevelEntry)">
- <summary>
- Define or redefine a Level using the values in the <see cref="T:log4net.Repository.Hierarchy.Hierarchy.LevelEntry"/> argument
- </summary>
- <param name="levelEntry">the level values</param>
- <remarks>
- <para>
- Define or redefine a Level using the values in the <see cref="T:log4net.Repository.Hierarchy.Hierarchy.LevelEntry"/> argument
- </para>
- <para>
- Supports setting levels via the configuration file.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Repository.Hierarchy.Hierarchy.AddProperty(log4net.Util.PropertyEntry)">
- <summary>
- Set a Property using the values in the <see cref="T:log4net.Repository.Hierarchy.Hierarchy.LevelEntry"/> argument
- </summary>
- <param name="propertyEntry">the property value</param>
- <remarks>
- <para>
- Set a Property using the values in the <see cref="T:log4net.Repository.Hierarchy.Hierarchy.LevelEntry"/> argument.
- </para>
- <para>
- Supports setting property values via the configuration file.
- </para>
- </remarks>
- </member>
- <member name="F:log4net.Repository.Hierarchy.Hierarchy.declaringType">
- <summary>
- The fully qualified type of the Hierarchy class.
- </summary>
- <remarks>
- Used by the internal logger to record the Type of the
- log message.
- </remarks>
- </member>
- <member name="E:log4net.Repository.Hierarchy.Hierarchy.LoggerCreatedEvent">
- <summary>
- Event used to notify that a logger has been created.
- </summary>
- <remarks>
- <para>
- Event raised when a logger is created.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Repository.Hierarchy.Hierarchy.EmittedNoAppenderWarning">
- <summary>
- Has no appender warning been emitted
- </summary>
- <remarks>
- <para>
- Flag to indicate if we have already issued a warning
- about not having an appender warning.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Repository.Hierarchy.Hierarchy.Root">
- <summary>
- Get the root of this hierarchy
- </summary>
- <remarks>
- <para>
- Get the root of this hierarchy.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Repository.Hierarchy.Hierarchy.LoggerFactory">
- <summary>
- Gets or sets the default <see cref="T:log4net.Repository.Hierarchy.ILoggerFactory"/> instance.
- </summary>
- <value>The default <see cref="T:log4net.Repository.Hierarchy.ILoggerFactory"/></value>
- <remarks>
- <para>
- The logger factory is used to create logger instances.
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Repository.Hierarchy.Hierarchy.LevelEntry">
- <summary>
- A class to hold the value, name and display name for a level
- </summary>
- <remarks>
- <para>
- A class to hold the value, name and display name for a level
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Repository.Hierarchy.Hierarchy.LevelEntry.ToString">
- <summary>
- Override <c>Object.ToString</c> to return sensible debug info
- </summary>
- <returns>string info about this object</returns>
- </member>
- <member name="P:log4net.Repository.Hierarchy.Hierarchy.LevelEntry.Value">
- <summary>
- Value of the level
- </summary>
- <remarks>
- <para>
- If the value is not set (defaults to -1) the value will be looked
- up for the current level with the same name.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Repository.Hierarchy.Hierarchy.LevelEntry.Name">
- <summary>
- Name of the level
- </summary>
- <value>
- The name of the level
- </value>
- <remarks>
- <para>
- The name of the level.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Repository.Hierarchy.Hierarchy.LevelEntry.DisplayName">
- <summary>
- Display name for the level
- </summary>
- <value>
- The display name of the level
- </value>
- <remarks>
- <para>
- The display name of the level.
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Repository.Hierarchy.LoggerKey">
- <summary>
- Used internally to accelerate hash table searches.
- </summary>
- <remarks>
- <para>
- Internal class used to improve performance of
- string keyed hashtables.
- </para>
- <para>
- The hashcode of the string is cached for reuse.
- The string is stored as an interned value.
- When comparing two <see cref="T:log4net.Repository.Hierarchy.LoggerKey"/> objects for equality
- the reference equality of the interned strings is compared.
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- <author>Gert Driesen</author>
- </member>
- <member name="M:log4net.Repository.Hierarchy.LoggerKey.#ctor(System.String)">
- <summary>
- Construct key with string name
- </summary>
- <remarks>
- <para>
- Initializes a new instance of the <see cref="T:log4net.Repository.Hierarchy.LoggerKey"/> class
- with the specified name.
- </para>
- <para>
- Stores the hashcode of the string and interns
- the string key to optimize comparisons.
- </para>
- <note>
- The Compact Framework 1.0 the <see cref="M:System.String.Intern(System.String)"/>
- method does not work. On the Compact Framework
- the string keys are not interned nor are they
- compared by reference.
- </note>
- </remarks>
- <param name="name">The name of the logger.</param>
- </member>
- <member name="M:log4net.Repository.Hierarchy.LoggerKey.GetHashCode">
- <summary>
- Returns a hash code for the current instance.
- </summary>
- <returns>A hash code for the current instance.</returns>
- <remarks>
- <para>
- Returns the cached hashcode.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Repository.Hierarchy.LoggerKey.Equals(System.Object)">
- <summary>
- Determines whether two <see cref="T:log4net.Repository.Hierarchy.LoggerKey"/> instances
- are equal.
- </summary>
- <param name="obj">The <see cref="T:System.Object"/> to compare with the current <see cref="T:log4net.Repository.Hierarchy.LoggerKey"/>.</param>
- <returns>
- <c>true</c> if the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:log4net.Repository.Hierarchy.LoggerKey"/>; otherwise, <c>false</c>.
- </returns>
- <remarks>
- <para>
- Compares the references of the interned strings.
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Repository.Hierarchy.ProvisionNode">
- <summary>
- Provision nodes are used where no logger instance has been specified
- </summary>
- <remarks>
- <para>
- <see cref="T:log4net.Repository.Hierarchy.ProvisionNode"/> instances are used in the
- <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/> when there is no specified
- <see cref="T:log4net.Repository.Hierarchy.Logger"/> for that node.
- </para>
- <para>
- A provision node holds a list of child loggers on behalf of
- a logger that does not exist.
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- <author>Gert Driesen</author>
- </member>
- <member name="M:log4net.Repository.Hierarchy.ProvisionNode.#ctor(log4net.Repository.Hierarchy.Logger)">
- <summary>
- Create a new provision node with child node
- </summary>
- <param name="log">A child logger to add to this node.</param>
- <remarks>
- <para>
- Initializes a new instance of the <see cref="T:log4net.Repository.Hierarchy.ProvisionNode"/> class
- with the specified child logger.
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Repository.Hierarchy.RootLogger">
- <summary>
- The <see cref="T:log4net.Repository.Hierarchy.RootLogger"/> sits at the root of the logger hierarchy tree.
- </summary>
- <remarks>
- <para>
- The <see cref="T:log4net.Repository.Hierarchy.RootLogger"/> is a regular <see cref="T:log4net.Repository.Hierarchy.Logger"/> except
- that it provides several guarantees.
- </para>
- <para>
- First, it cannot be assigned a <c>null</c>
- level. Second, since the root logger cannot have a parent, the
- <see cref="P:log4net.Repository.Hierarchy.RootLogger.EffectiveLevel"/> property always returns the value of the
- level field without walking the hierarchy.
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- <author>Gert Driesen</author>
- </member>
- <member name="M:log4net.Repository.Hierarchy.RootLogger.#ctor(log4net.Core.Level)">
- <summary>
- Construct a <see cref="T:log4net.Repository.Hierarchy.RootLogger"/>
- </summary>
- <param name="level">The level to assign to the root logger.</param>
- <remarks>
- <para>
- Initializes a new instance of the <see cref="T:log4net.Repository.Hierarchy.RootLogger"/> class with
- the specified logging level.
- </para>
- <para>
- The root logger names itself as "root". However, the root
- logger cannot be retrieved by name.
- </para>
- </remarks>
- </member>
- <member name="F:log4net.Repository.Hierarchy.RootLogger.declaringType">
- <summary>
- The fully qualified type of the RootLogger class.
- </summary>
- <remarks>
- Used by the internal logger to record the Type of the
- log message.
- </remarks>
- </member>
- <member name="P:log4net.Repository.Hierarchy.RootLogger.EffectiveLevel">
- <summary>
- Gets the assigned level value without walking the logger hierarchy.
- </summary>
- <value>The assigned level value without walking the logger hierarchy.</value>
- <remarks>
- <para>
- Because the root logger cannot have a parent and its level
- must not be <c>null</c> this property just returns the
- value of <see cref="P:log4net.Repository.Hierarchy.Logger.Level"/>.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Repository.Hierarchy.RootLogger.Level">
- <summary>
- Gets or sets the assigned <see cref="P:log4net.Repository.Hierarchy.RootLogger.Level"/> for the root logger.
- </summary>
- <value>
- The <see cref="P:log4net.Repository.Hierarchy.RootLogger.Level"/> of the root logger.
- </value>
- <remarks>
- <para>
- Setting the level of the root logger to a <c>null</c> reference
- may have catastrophic results. We prevent this here.
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Repository.Hierarchy.XmlHierarchyConfigurator">
- <summary>
- Initializes the log4net environment using an XML DOM.
- </summary>
- <remarks>
- <para>
- Configures a <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/> using an XML DOM.
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- <author>Gert Driesen</author>
- </member>
- <member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.#ctor(log4net.Repository.Hierarchy.Hierarchy)">
- <summary>
- Construct the configurator for a hierarchy
- </summary>
- <param name="hierarchy">The hierarchy to build.</param>
- <remarks>
- <para>
- Initializes a new instance of the <see cref="T:log4net.Repository.Hierarchy.XmlHierarchyConfigurator"/> class
- with the specified <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/>.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.Configure(System.Xml.XmlElement)">
- <summary>
- Configure the hierarchy by parsing a DOM tree of XML elements.
- </summary>
- <param name="element">The root element to parse.</param>
- <remarks>
- <para>
- Configure the hierarchy by parsing a DOM tree of XML elements.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.FindAppenderByReference(System.Xml.XmlElement)">
- <summary>
- Parse appenders by IDREF.
- </summary>
- <param name="appenderRef">The appender ref element.</param>
- <returns>The instance of the appender that the ref refers to.</returns>
- <remarks>
- <para>
- Parse an XML element that represents an appender and return
- the appender.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.ParseAppender(System.Xml.XmlElement)">
- <summary>
- Parses an appender element.
- </summary>
- <param name="appenderElement">The appender element.</param>
- <returns>The appender instance or <c>null</c> when parsing failed.</returns>
- <remarks>
- <para>
- Parse an XML element that represents an appender and return
- the appender instance.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.ParseLogger(System.Xml.XmlElement)">
- <summary>
- Parses a logger element.
- </summary>
- <param name="loggerElement">The logger element.</param>
- <remarks>
- <para>
- Parse an XML element that represents a logger.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.ParseRoot(System.Xml.XmlElement)">
- <summary>
- Parses the root logger element.
- </summary>
- <param name="rootElement">The root element.</param>
- <remarks>
- <para>
- Parse an XML element that represents the root logger.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.ParseChildrenOfLoggerElement(System.Xml.XmlElement,log4net.Repository.Hierarchy.Logger,System.Boolean)">
- <summary>
- Parses the children of a logger element.
- </summary>
- <param name="catElement">The category element.</param>
- <param name="log">The logger instance.</param>
- <param name="isRoot">Flag to indicate if the logger is the root logger.</param>
- <remarks>
- <para>
- Parse the child elements of a <logger> element.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.ParseRenderer(System.Xml.XmlElement)">
- <summary>
- Parses an object renderer.
- </summary>
- <param name="element">The renderer element.</param>
- <remarks>
- <para>
- Parse an XML element that represents a renderer.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.ParseLevel(System.Xml.XmlElement,log4net.Repository.Hierarchy.Logger,System.Boolean)">
- <summary>
- Parses a level element.
- </summary>
- <param name="element">The level element.</param>
- <param name="log">The logger object to set the level on.</param>
- <param name="isRoot">Flag to indicate if the logger is the root logger.</param>
- <remarks>
- <para>
- Parse an XML element that represents a level.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.SetParameter(System.Xml.XmlElement,System.Object)">
- <summary>
- Sets a parameter on an object.
- </summary>
- <param name="element">The parameter element.</param>
- <param name="target">The object to set the parameter on.</param>
- <remarks>
- The parameter name must correspond to a writable property
- on the object. The value of the parameter is a string,
- therefore this function will attempt to set a string
- property first. If unable to set a string property it
- will inspect the property and its argument type. It will
- attempt to call a static method called <c>Parse</c> on the
- type of the property. This method will take a single
- string argument and return a value that can be used to
- set the property.
- </remarks>
- </member>
- <member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.HasAttributesOrElements(System.Xml.XmlElement)">
- <summary>
- Test if an element has no attributes or child elements
- </summary>
- <param name="element">the element to inspect</param>
- <returns><c>true</c> if the element has any attributes or child elements, <c>false</c> otherwise</returns>
- </member>
- <member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.IsTypeConstructible(System.Type)">
- <summary>
- Test if a <see cref="T:System.Type"/> is constructible with <c>Activator.CreateInstance</c>.
- </summary>
- <param name="type">the type to inspect</param>
- <returns><c>true</c> if the type is creatable using a default constructor, <c>false</c> otherwise</returns>
- </member>
- <member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.FindMethodInfo(System.Type,System.String)">
- <summary>
- Look for a method on the <paramref name="targetType"/> that matches the <paramref name="name"/> supplied
- </summary>
- <param name="targetType">the type that has the method</param>
- <param name="name">the name of the method</param>
- <returns>the method info found</returns>
- <remarks>
- <para>
- The method must be a public instance method on the <paramref name="targetType"/>.
- The method must be named <paramref name="name"/> or "Add" followed by <paramref name="name"/>.
- The method must take a single parameter.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.ConvertStringTo(System.Type,System.String)">
- <summary>
- Converts a string value to a target type.
- </summary>
- <param name="type">The type of object to convert the string to.</param>
- <param name="value">The string value to use as the value of the object.</param>
- <returns>
- <para>
- An object of type <paramref name="type"/> with value <paramref name="value"/> or
- <c>null</c> when the conversion could not be performed.
- </para>
- </returns>
- </member>
- <member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.CreateObjectFromXml(System.Xml.XmlElement,System.Type,System.Type)">
- <summary>
- Creates an object as specified in XML.
- </summary>
- <param name="element">The XML element that contains the definition of the object.</param>
- <param name="defaultTargetType">The object type to use if not explicitly specified.</param>
- <param name="typeConstraint">The type that the returned object must be or must inherit from.</param>
- <returns>The object or <c>null</c></returns>
- <remarks>
- <para>
- Parse an XML element and create an object instance based on the configuration
- data.
- </para>
- <para>
- The type of the instance may be specified in the XML. If not
- specified then the <paramref name="defaultTargetType"/> is used
- as the type. However the type is specified it must support the
- <paramref name="typeConstraint"/> type.
- </para>
- </remarks>
- </member>
- <member name="F:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.m_appenderBag">
- <summary>
- key: appenderName, value: appender.
- </summary>
- </member>
- <member name="F:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.m_hierarchy">
- <summary>
- The Hierarchy being configured.
- </summary>
- </member>
- <member name="F:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.declaringType">
- <summary>
- The fully qualified type of the XmlHierarchyConfigurator class.
- </summary>
- <remarks>
- Used by the internal logger to record the Type of the
- log message.
- </remarks>
- </member>
- <member name="T:log4net.Repository.ConfigurationChangedEventArgs">
- <summary>
-
- </summary>
- </member>
- <member name="M:log4net.Repository.ConfigurationChangedEventArgs.#ctor(System.Collections.ICollection)">
- <summary>
-
- </summary>
- <param name="configurationMessages"></param>
- </member>
- <member name="P:log4net.Repository.ConfigurationChangedEventArgs.ConfigurationMessages">
- <summary>
-
- </summary>
- </member>
- <member name="T:log4net.Repository.LoggerRepositoryShutdownEventHandler">
- <summary>
- Delegate used to handle logger repository shutdown event notifications
- </summary>
- <param name="sender">The <see cref="T:log4net.Repository.ILoggerRepository"/> that is shutting down.</param>
- <param name="e">Empty event args</param>
- <remarks>
- <para>
- Delegate used to handle logger repository shutdown event notifications.
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Repository.LoggerRepositoryConfigurationResetEventHandler">
- <summary>
- Delegate used to handle logger repository configuration reset event notifications
- </summary>
- <param name="sender">The <see cref="T:log4net.Repository.ILoggerRepository"/> that has had its configuration reset.</param>
- <param name="e">Empty event args</param>
- <remarks>
- <para>
- Delegate used to handle logger repository configuration reset event notifications.
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Repository.LoggerRepositoryConfigurationChangedEventHandler">
- <summary>
- Delegate used to handle event notifications for logger repository configuration changes.
- </summary>
- <param name="sender">The <see cref="T:log4net.Repository.ILoggerRepository"/> that has had its configuration changed.</param>
- <param name="e">Empty event arguments.</param>
- <remarks>
- <para>
- Delegate used to handle event notifications for logger repository configuration changes.
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Util.PatternStringConverters.AppDomainPatternConverter">
- <summary>
- Write the name of the current AppDomain to the output
- </summary>
- <remarks>
- <para>
- Write the name of the current AppDomain to the output writer
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- </member>
- <member name="M:log4net.Util.PatternStringConverters.AppDomainPatternConverter.Convert(System.IO.TextWriter,System.Object)">
- <summary>
- Write the name of the current AppDomain to the output
- </summary>
- <param name="writer">the writer to write to</param>
- <param name="state">null, state is not set</param>
- <remarks>
- <para>
- Writes name of the current AppDomain to the output <paramref name="writer"/>.
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Util.PatternStringConverters.DatePatternConverter">
- <summary>
- Write the current date to the output
- </summary>
- <remarks>
- <para>
- Date pattern converter, uses a <see cref="T:log4net.DateFormatter.IDateFormatter"/> to format
- the current date and time to the writer as a string.
- </para>
- <para>
- The value of the <see cref="P:log4net.Util.PatternConverter.Option"/> determines
- the formatting of the date. The following values are allowed:
- <list type="definition">
- <listheader>
- <term>Option value</term>
- <description>Output</description>
- </listheader>
- <item>
- <term>ISO8601</term>
- <description>
- Uses the <see cref="T:log4net.DateFormatter.Iso8601DateFormatter"/> formatter.
- Formats using the <c>"yyyy-MM-dd HH:mm:ss,fff"</c> pattern.
- </description>
- </item>
- <item>
- <term>DATE</term>
- <description>
- Uses the <see cref="T:log4net.DateFormatter.DateTimeDateFormatter"/> formatter.
- Formats using the <c>"dd MMM yyyy HH:mm:ss,fff"</c> for example, <c>"06 Nov 1994 15:49:37,459"</c>.
- </description>
- </item>
- <item>
- <term>ABSOLUTE</term>
- <description>
- Uses the <see cref="T:log4net.DateFormatter.AbsoluteTimeDateFormatter"/> formatter.
- Formats using the <c>"HH:mm:ss,fff"</c> for example, <c>"15:49:37,459"</c>.
- </description>
- </item>
- <item>
- <term>other</term>
- <description>
- Any other pattern string uses the <see cref="T:log4net.DateFormatter.SimpleDateFormatter"/> formatter.
- This formatter passes the pattern string to the <see cref="T:System.DateTime"/>
- <see cref="M:DateTime.ToString(string)"/> method.
- For details on valid patterns see
- <a href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpref/html/frlrfsystemglobalizationdatetimeformatinfoclasstopic.asp">DateTimeFormatInfo Class</a>.
- </description>
- </item>
- </list>
- </para>
- <para>
- The date and time is in the local time zone and is rendered in that zone.
- To output the time in Universal time see <see cref="T:log4net.Util.PatternStringConverters.UtcDatePatternConverter"/>.
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- </member>
- <member name="F:log4net.Util.PatternStringConverters.DatePatternConverter.m_dateFormatter">
- <summary>
- The <see cref="T:log4net.DateFormatter.IDateFormatter"/> used to render the date to a string
- </summary>
- <remarks>
- <para>
- The <see cref="T:log4net.DateFormatter.IDateFormatter"/> used to render the date to a string
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.PatternStringConverters.DatePatternConverter.ActivateOptions">
- <summary>
- Initialize the converter options
- </summary>
- <remarks>
- <para>
- This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
- activation scheme. The <see cref="M:log4net.Util.PatternStringConverters.DatePatternConverter.ActivateOptions"/> method must
- be called on this object after the configuration properties have
- been set. Until <see cref="M:log4net.Util.PatternStringConverters.DatePatternConverter.ActivateOptions"/> is called this
- object is in an undefined state and must not be used.
- </para>
- <para>
- If any of the configuration properties are modified then
- <see cref="M:log4net.Util.PatternStringConverters.DatePatternConverter.ActivateOptions"/> must be called again.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.PatternStringConverters.DatePatternConverter.Convert(System.IO.TextWriter,System.Object)">
- <summary>
- Write the current date to the output
- </summary>
- <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
- <param name="state">null, state is not set</param>
- <remarks>
- <para>
- Pass the current date and time to the <see cref="T:log4net.DateFormatter.IDateFormatter"/>
- for it to render it to the writer.
- </para>
- <para>
- The date and time passed is in the local time zone.
- </para>
- </remarks>
- </member>
- <member name="F:log4net.Util.PatternStringConverters.DatePatternConverter.declaringType">
- <summary>
- The fully qualified type of the DatePatternConverter class.
- </summary>
- <remarks>
- Used by the internal logger to record the Type of the
- log message.
- </remarks>
- </member>
- <member name="T:log4net.Util.PatternStringConverters.EnvironmentFolderPathPatternConverter">
- <summary>
- Write an <see cref="T:System.Environment.SpecialFolder"/> folder path to the output
- </summary>
- <remarks>
- <para>
- Write an special path environment folder path to the output writer.
- The value of the <see cref="P:log4net.Util.PatternConverter.Option"/> determines
- the name of the variable to output. <see cref="P:log4net.Util.PatternConverter.Option"/>
- should be a value in the <see cref="T:System.Environment.SpecialFolder"/> enumeration.
- </para>
- </remarks>
- <author>Ron Grabowski</author>
- </member>
- <member name="M:log4net.Util.PatternStringConverters.EnvironmentFolderPathPatternConverter.Convert(System.IO.TextWriter,System.Object)">
- <summary>
- Write an special path environment folder path to the output
- </summary>
- <param name="writer">the writer to write to</param>
- <param name="state">null, state is not set</param>
- <remarks>
- <para>
- Writes the special path environment folder path to the output <paramref name="writer"/>.
- The name of the special path environment folder path to output must be set
- using the <see cref="P:log4net.Util.PatternConverter.Option"/>
- property.
- </para>
- </remarks>
- </member>
- <member name="F:log4net.Util.PatternStringConverters.EnvironmentFolderPathPatternConverter.declaringType">
- <summary>
- The fully qualified type of the EnvironmentFolderPathPatternConverter class.
- </summary>
- <remarks>
- Used by the internal logger to record the Type of the
- log message.
- </remarks>
- </member>
- <member name="T:log4net.Util.PatternStringConverters.EnvironmentPatternConverter">
- <summary>
- Write an environment variable to the output
- </summary>
- <remarks>
- <para>
- Write an environment variable to the output writer.
- The value of the <see cref="P:log4net.Util.PatternConverter.Option"/> determines
- the name of the variable to output.
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- </member>
- <member name="M:log4net.Util.PatternStringConverters.EnvironmentPatternConverter.Convert(System.IO.TextWriter,System.Object)">
- <summary>
- Write an environment variable to the output
- </summary>
- <param name="writer">the writer to write to</param>
- <param name="state">null, state is not set</param>
- <remarks>
- <para>
- Writes the environment variable to the output <paramref name="writer"/>.
- The name of the environment variable to output must be set
- using the <see cref="P:log4net.Util.PatternConverter.Option"/>
- property.
- </para>
- </remarks>
- </member>
- <member name="F:log4net.Util.PatternStringConverters.EnvironmentPatternConverter.declaringType">
- <summary>
- The fully qualified type of the EnvironmentPatternConverter class.
- </summary>
- <remarks>
- Used by the internal logger to record the Type of the
- log message.
- </remarks>
- </member>
- <member name="T:log4net.Util.PatternStringConverters.IdentityPatternConverter">
- <summary>
- Write the current thread identity to the output
- </summary>
- <remarks>
- <para>
- Write the current thread identity to the output writer
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- </member>
- <member name="M:log4net.Util.PatternStringConverters.IdentityPatternConverter.Convert(System.IO.TextWriter,System.Object)">
- <summary>
- Write the current thread identity to the output
- </summary>
- <param name="writer">the writer to write to</param>
- <param name="state">null, state is not set</param>
- <remarks>
- <para>
- Writes the current thread identity to the output <paramref name="writer"/>.
- </para>
- </remarks>
- </member>
- <member name="F:log4net.Util.PatternStringConverters.IdentityPatternConverter.declaringType">
- <summary>
- The fully qualified type of the IdentityPatternConverter class.
- </summary>
- <remarks>
- Used by the internal logger to record the Type of the
- log message.
- </remarks>
- </member>
- <member name="T:log4net.Util.PatternStringConverters.LiteralPatternConverter">
- <summary>
- Pattern converter for literal string instances in the pattern
- </summary>
- <remarks>
- <para>
- Writes the literal string value specified in the
- <see cref="P:log4net.Util.PatternConverter.Option"/> property to
- the output.
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- </member>
- <member name="M:log4net.Util.PatternStringConverters.LiteralPatternConverter.SetNext(log4net.Util.PatternConverter)">
- <summary>
- Set the next converter in the chain
- </summary>
- <param name="pc">The next pattern converter in the chain</param>
- <returns>The next pattern converter</returns>
- <remarks>
- <para>
- Special case the building of the pattern converter chain
- for <see cref="T:log4net.Util.PatternStringConverters.LiteralPatternConverter"/> instances. Two adjacent
- literals in the pattern can be represented by a single combined
- pattern converter. This implementation detects when a
- <see cref="T:log4net.Util.PatternStringConverters.LiteralPatternConverter"/> is added to the chain
- after this converter and combines its value with this converter's
- literal value.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.PatternStringConverters.LiteralPatternConverter.Format(System.IO.TextWriter,System.Object)">
- <summary>
- Write the literal to the output
- </summary>
- <param name="writer">the writer to write to</param>
- <param name="state">null, not set</param>
- <remarks>
- <para>
- Override the formatting behavior to ignore the FormattingInfo
- because we have a literal instead.
- </para>
- <para>
- Writes the value of <see cref="P:log4net.Util.PatternConverter.Option"/>
- to the output <paramref name="writer"/>.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.PatternStringConverters.LiteralPatternConverter.Convert(System.IO.TextWriter,System.Object)">
- <summary>
- Convert this pattern into the rendered message
- </summary>
- <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
- <param name="state">null, not set</param>
- <remarks>
- <para>
- This method is not used.
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Util.PatternStringConverters.NewLinePatternConverter">
- <summary>
- Writes a newline to the output
- </summary>
- <remarks>
- <para>
- Writes the system dependent line terminator to the output.
- This behavior can be overridden by setting the <see cref="P:log4net.Util.PatternConverter.Option"/>:
- </para>
- <list type="definition">
- <listheader>
- <term>Option Value</term>
- <description>Output</description>
- </listheader>
- <item>
- <term>DOS</term>
- <description>DOS or Windows line terminator <c>"\r\n"</c></description>
- </item>
- <item>
- <term>UNIX</term>
- <description>UNIX line terminator <c>"\n"</c></description>
- </item>
- </list>
- </remarks>
- <author>Nicko Cadell</author>
- </member>
- <member name="M:log4net.Util.PatternStringConverters.NewLinePatternConverter.ActivateOptions">
- <summary>
- Initialize the converter
- </summary>
- <remarks>
- <para>
- This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
- activation scheme. The <see cref="M:log4net.Util.PatternStringConverters.NewLinePatternConverter.ActivateOptions"/> method must
- be called on this object after the configuration properties have
- been set. Until <see cref="M:log4net.Util.PatternStringConverters.NewLinePatternConverter.ActivateOptions"/> is called this
- object is in an undefined state and must not be used.
- </para>
- <para>
- If any of the configuration properties are modified then
- <see cref="M:log4net.Util.PatternStringConverters.NewLinePatternConverter.ActivateOptions"/> must be called again.
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Util.PatternStringConverters.ProcessIdPatternConverter">
- <summary>
- Write the current process ID to the output
- </summary>
- <remarks>
- <para>
- Write the current process ID to the output writer
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- </member>
- <member name="M:log4net.Util.PatternStringConverters.ProcessIdPatternConverter.Convert(System.IO.TextWriter,System.Object)">
- <summary>
- Write the current process ID to the output
- </summary>
- <param name="writer">the writer to write to</param>
- <param name="state">null, state is not set</param>
- <remarks>
- <para>
- Write the current process ID to the output <paramref name="writer"/>.
- </para>
- </remarks>
- </member>
- <member name="F:log4net.Util.PatternStringConverters.ProcessIdPatternConverter.declaringType">
- <summary>
- The fully qualified type of the ProcessIdPatternConverter class.
- </summary>
- <remarks>
- Used by the internal logger to record the Type of the
- log message.
- </remarks>
- </member>
- <member name="T:log4net.Util.PatternStringConverters.PropertyPatternConverter">
- <summary>
- Property pattern converter
- </summary>
- <remarks>
- <para>
- This pattern converter reads the thread and global properties.
- The thread properties take priority over global properties.
- See <see cref="P:log4net.ThreadContext.Properties"/> for details of the
- thread properties. See <see cref="P:log4net.GlobalContext.Properties"/> for
- details of the global properties.
- </para>
- <para>
- If the <see cref="P:log4net.Util.PatternConverter.Option"/> is specified then that will be used to
- lookup a single property. If no <see cref="P:log4net.Util.PatternConverter.Option"/> is specified
- then all properties will be dumped as a list of key value pairs.
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- </member>
- <member name="M:log4net.Util.PatternStringConverters.PropertyPatternConverter.Convert(System.IO.TextWriter,System.Object)">
- <summary>
- Write the property value to the output
- </summary>
- <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
- <param name="state">null, state is not set</param>
- <remarks>
- <para>
- Writes out the value of a named property. The property name
- should be set in the <see cref="P:log4net.Util.PatternConverter.Option"/>
- property.
- </para>
- <para>
- If the <see cref="P:log4net.Util.PatternConverter.Option"/> is set to <c>null</c>
- then all the properties are written as key value pairs.
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Util.PatternStringConverters.RandomStringPatternConverter">
- <summary>
- A Pattern converter that generates a string of random characters
- </summary>
- <remarks>
- <para>
- The converter generates a string of random characters. By default
- the string is length 4. This can be changed by setting the <see cref="P:log4net.Util.PatternConverter.Option"/>
- to the string value of the length required.
- </para>
- <para>
- The random characters in the string are limited to uppercase letters
- and numbers only.
- </para>
- <para>
- The random number generator used by this class is not cryptographically secure.
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- </member>
- <member name="F:log4net.Util.PatternStringConverters.RandomStringPatternConverter.s_random">
- <summary>
- Shared random number generator
- </summary>
- </member>
- <member name="F:log4net.Util.PatternStringConverters.RandomStringPatternConverter.m_length">
- <summary>
- Length of random string to generate. Default length 4.
- </summary>
- </member>
- <member name="M:log4net.Util.PatternStringConverters.RandomStringPatternConverter.ActivateOptions">
- <summary>
- Initialize the converter options
- </summary>
- <remarks>
- <para>
- This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
- activation scheme. The <see cref="M:log4net.Util.PatternStringConverters.RandomStringPatternConverter.ActivateOptions"/> method must
- be called on this object after the configuration properties have
- been set. Until <see cref="M:log4net.Util.PatternStringConverters.RandomStringPatternConverter.ActivateOptions"/> is called this
- object is in an undefined state and must not be used.
- </para>
- <para>
- If any of the configuration properties are modified then
- <see cref="M:log4net.Util.PatternStringConverters.RandomStringPatternConverter.ActivateOptions"/> must be called again.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.PatternStringConverters.RandomStringPatternConverter.Convert(System.IO.TextWriter,System.Object)">
- <summary>
- Write a randoim string to the output
- </summary>
- <param name="writer">the writer to write to</param>
- <param name="state">null, state is not set</param>
- <remarks>
- <para>
- Write a randoim string to the output <paramref name="writer"/>.
- </para>
- </remarks>
- </member>
- <member name="F:log4net.Util.PatternStringConverters.RandomStringPatternConverter.declaringType">
- <summary>
- The fully qualified type of the RandomStringPatternConverter class.
- </summary>
- <remarks>
- Used by the internal logger to record the Type of the
- log message.
- </remarks>
- </member>
- <member name="T:log4net.Util.PatternStringConverters.UserNamePatternConverter">
- <summary>
- Write the current threads username to the output
- </summary>
- <remarks>
- <para>
- Write the current threads username to the output writer
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- </member>
- <member name="M:log4net.Util.PatternStringConverters.UserNamePatternConverter.Convert(System.IO.TextWriter,System.Object)">
- <summary>
- Write the current threads username to the output
- </summary>
- <param name="writer">the writer to write to</param>
- <param name="state">null, state is not set</param>
- <remarks>
- <para>
- Write the current threads username to the output <paramref name="writer"/>.
- </para>
- </remarks>
- </member>
- <member name="F:log4net.Util.PatternStringConverters.UserNamePatternConverter.declaringType">
- <summary>
- The fully qualified type of the UserNamePatternConverter class.
- </summary>
- <remarks>
- Used by the internal logger to record the Type of the
- log message.
- </remarks>
- </member>
- <member name="T:log4net.Util.PatternStringConverters.UtcDatePatternConverter">
- <summary>
- Write the UTC date time to the output
- </summary>
- <remarks>
- <para>
- Date pattern converter, uses a <see cref="T:log4net.DateFormatter.IDateFormatter"/> to format
- the current date and time in Universal time.
- </para>
- <para>
- See the <see cref="T:log4net.Util.PatternStringConverters.DatePatternConverter"/> for details on the date pattern syntax.
- </para>
- </remarks>
- <seealso cref="T:log4net.Util.PatternStringConverters.DatePatternConverter"/>
- <author>Nicko Cadell</author>
- </member>
- <member name="M:log4net.Util.PatternStringConverters.UtcDatePatternConverter.Convert(System.IO.TextWriter,System.Object)">
- <summary>
- Write the current date and time to the output
- </summary>
- <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
- <param name="state">null, state is not set</param>
- <remarks>
- <para>
- Pass the current date and time to the <see cref="T:log4net.DateFormatter.IDateFormatter"/>
- for it to render it to the writer.
- </para>
- <para>
- The date is in Universal time when it is rendered.
- </para>
- </remarks>
- <seealso cref="T:log4net.Util.PatternStringConverters.DatePatternConverter"/>
- </member>
- <member name="F:log4net.Util.PatternStringConverters.UtcDatePatternConverter.declaringType">
- <summary>
- The fully qualified type of the UtcDatePatternConverter class.
- </summary>
- <remarks>
- Used by the internal logger to record the Type of the
- log message.
- </remarks>
- </member>
- <member name="T:log4net.Util.TypeConverters.BooleanConverter">
- <summary>
- Type converter for Boolean.
- </summary>
- <remarks>
- <para>
- Supports conversion from string to <c>bool</c> type.
- </para>
- </remarks>
- <seealso cref="T:log4net.Util.TypeConverters.ConverterRegistry"/>
- <seealso cref="T:log4net.Util.TypeConverters.IConvertFrom"/>
- <seealso cref="T:log4net.Util.TypeConverters.IConvertTo"/>
- <author>Nicko Cadell</author>
- <author>Gert Driesen</author>
- </member>
- <member name="M:log4net.Util.TypeConverters.BooleanConverter.CanConvertFrom(System.Type)">
- <summary>
- Can the source type be converted to the type supported by this object
- </summary>
- <param name="sourceType">the type to convert</param>
- <returns>true if the conversion is possible</returns>
- <remarks>
- <para>
- Returns <c>true</c> if the <paramref name="sourceType"/> is
- the <see cref="T:System.String"/> type.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.TypeConverters.BooleanConverter.ConvertFrom(System.Object)">
- <summary>
- Convert the source object to the type supported by this object
- </summary>
- <param name="source">the object to convert</param>
- <returns>the converted object</returns>
- <remarks>
- <para>
- Uses the <see cref="M:System.Boolean.Parse(System.String)"/> method to convert the
- <see cref="T:System.String"/> argument to a <see cref="T:System.Boolean"/>.
- </para>
- </remarks>
- <exception cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException">
- The <paramref name="source"/> object cannot be converted to the
- target type. To check for this condition use the <see cref="M:log4net.Util.TypeConverters.BooleanConverter.CanConvertFrom(System.Type)"/>
- method.
- </exception>
- </member>
- <member name="T:log4net.Util.TypeConverters.ConversionNotSupportedException">
- <summary>
- Exception base type for conversion errors.
- </summary>
- <remarks>
- <para>
- This type extends <see cref="T:System.ApplicationException"/>. It
- does not add any new functionality but does differentiate the
- type of exception being thrown.
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- <author>Gert Driesen</author>
- </member>
- <member name="M:log4net.Util.TypeConverters.ConversionNotSupportedException.#ctor">
- <summary>
- Constructor
- </summary>
- <remarks>
- <para>
- Initializes a new instance of the <see cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException"/> class.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.TypeConverters.ConversionNotSupportedException.#ctor(System.String)">
- <summary>
- Constructor
- </summary>
- <param name="message">A message to include with the exception.</param>
- <remarks>
- <para>
- Initializes a new instance of the <see cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException"/> class
- with the specified message.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.TypeConverters.ConversionNotSupportedException.#ctor(System.String,System.Exception)">
- <summary>
- Constructor
- </summary>
- <param name="message">A message to include with the exception.</param>
- <param name="innerException">A nested exception to include.</param>
- <remarks>
- <para>
- Initializes a new instance of the <see cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException"/> class
- with the specified message and inner exception.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.TypeConverters.ConversionNotSupportedException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Serialization constructor
- </summary>
- <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
- <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
- <remarks>
- <para>
- Initializes a new instance of the <see cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException"/> class
- with serialized data.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.TypeConverters.ConversionNotSupportedException.Create(System.Type,System.Object)">
- <summary>
- Creates a new instance of the <see cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException"/> class.
- </summary>
- <param name="destinationType">The conversion destination type.</param>
- <param name="sourceValue">The value to convert.</param>
- <returns>An instance of the <see cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException"/>.</returns>
- <remarks>
- <para>
- Creates a new instance of the <see cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException"/> class.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.TypeConverters.ConversionNotSupportedException.Create(System.Type,System.Object,System.Exception)">
- <summary>
- Creates a new instance of the <see cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException"/> class.
- </summary>
- <param name="destinationType">The conversion destination type.</param>
- <param name="sourceValue">The value to convert.</param>
- <param name="innerException">A nested exception to include.</param>
- <returns>An instance of the <see cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException"/>.</returns>
- <remarks>
- <para>
- Creates a new instance of the <see cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException"/> class.
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Util.TypeConverters.ConverterRegistry">
- <summary>
- Register of type converters for specific types.
- </summary>
- <remarks>
- <para>
- Maintains a registry of type converters used to convert between
- types.
- </para>
- <para>
- Use the <see cref="M:AddConverter(Type, object)"/> and
- <see cref="M:AddConverter(Type, Type)"/> methods to register new converters.
- The <see cref="M:log4net.Util.TypeConverters.ConverterRegistry.GetConvertTo(System.Type,System.Type)"/> and <see cref="M:log4net.Util.TypeConverters.ConverterRegistry.GetConvertFrom(System.Type)"/> methods
- lookup appropriate converters to use.
- </para>
- </remarks>
- <seealso cref="T:log4net.Util.TypeConverters.IConvertFrom"/>
- <seealso cref="T:log4net.Util.TypeConverters.IConvertTo"/>
- <author>Nicko Cadell</author>
- <author>Gert Driesen</author>
- </member>
- <member name="M:log4net.Util.TypeConverters.ConverterRegistry.#ctor">
- <summary>
- Private constructor
- </summary>
- <remarks>
- Initializes a new instance of the <see cref="T:log4net.Util.TypeConverters.ConverterRegistry"/> class.
- </remarks>
- </member>
- <member name="M:log4net.Util.TypeConverters.ConverterRegistry.#cctor">
- <summary>
- Static constructor.
- </summary>
- <remarks>
- <para>
- This constructor defines the intrinsic type converters.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.TypeConverters.ConverterRegistry.AddConverter(System.Type,System.Object)">
- <summary>
- Adds a converter for a specific type.
- </summary>
- <param name="destinationType">The type being converted to.</param>
- <param name="converter">The type converter to use to convert to the destination type.</param>
- <remarks>
- <para>
- Adds a converter instance for a specific type.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.TypeConverters.ConverterRegistry.AddConverter(System.Type,System.Type)">
- <summary>
- Adds a converter for a specific type.
- </summary>
- <param name="destinationType">The type being converted to.</param>
- <param name="converterType">The type of the type converter to use to convert to the destination type.</param>
- <remarks>
- <para>
- Adds a converter <see cref="T:System.Type"/> for a specific type.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.TypeConverters.ConverterRegistry.GetConvertTo(System.Type,System.Type)">
- <summary>
- Gets the type converter to use to convert values to the destination type.
- </summary>
- <param name="sourceType">The type being converted from.</param>
- <param name="destinationType">The type being converted to.</param>
- <returns>
- The type converter instance to use for type conversions or <c>null</c>
- if no type converter is found.
- </returns>
- <remarks>
- <para>
- Gets the type converter to use to convert values to the destination type.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.TypeConverters.ConverterRegistry.GetConvertFrom(System.Type)">
- <summary>
- Gets the type converter to use to convert values to the destination type.
- </summary>
- <param name="destinationType">The type being converted to.</param>
- <returns>
- The type converter instance to use for type conversions or <c>null</c>
- if no type converter is found.
- </returns>
- <remarks>
- <para>
- Gets the type converter to use to convert values to the destination type.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.TypeConverters.ConverterRegistry.GetConverterFromAttribute(System.Type)">
- <summary>
- Lookups the type converter to use as specified by the attributes on the
- destination type.
- </summary>
- <param name="destinationType">The type being converted to.</param>
- <returns>
- The type converter instance to use for type conversions or <c>null</c>
- if no type converter is found.
- </returns>
- </member>
- <member name="M:log4net.Util.TypeConverters.ConverterRegistry.CreateConverterInstance(System.Type)">
- <summary>
- Creates the instance of the type converter.
- </summary>
- <param name="converterType">The type of the type converter.</param>
- <returns>
- The type converter instance to use for type conversions or <c>null</c>
- if no type converter is found.
- </returns>
- <remarks>
- <para>
- The type specified for the type converter must implement
- the <see cref="T:log4net.Util.TypeConverters.IConvertFrom"/> or <see cref="T:log4net.Util.TypeConverters.IConvertTo"/> interfaces
- and must have a public default (no argument) constructor.
- </para>
- </remarks>
- </member>
- <member name="F:log4net.Util.TypeConverters.ConverterRegistry.declaringType">
- <summary>
- The fully qualified type of the ConverterRegistry class.
- </summary>
- <remarks>
- Used by the internal logger to record the Type of the
- log message.
- </remarks>
- </member>
- <member name="F:log4net.Util.TypeConverters.ConverterRegistry.s_type2converter">
- <summary>
- Mapping from <see cref="T:System.Type"/> to type converter.
- </summary>
- </member>
- <member name="T:log4net.Util.TypeConverters.EncodingConverter">
- <summary>
- Supports conversion from string to <see cref="T:System.Text.Encoding"/> type.
- </summary>
- <remarks>
- <para>
- Supports conversion from string to <see cref="T:System.Text.Encoding"/> type.
- </para>
- </remarks>
- <seealso cref="T:log4net.Util.TypeConverters.ConverterRegistry"/>
- <seealso cref="T:log4net.Util.TypeConverters.IConvertFrom"/>
- <seealso cref="T:log4net.Util.TypeConverters.IConvertTo"/>
- <author>Nicko Cadell</author>
- <author>Gert Driesen</author>
- </member>
- <member name="M:log4net.Util.TypeConverters.EncodingConverter.CanConvertFrom(System.Type)">
- <summary>
- Can the source type be converted to the type supported by this object
- </summary>
- <param name="sourceType">the type to convert</param>
- <returns>true if the conversion is possible</returns>
- <remarks>
- <para>
- Returns <c>true</c> if the <paramref name="sourceType"/> is
- the <see cref="T:System.String"/> type.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.TypeConverters.EncodingConverter.ConvertFrom(System.Object)">
- <summary>
- Overrides the ConvertFrom method of IConvertFrom.
- </summary>
- <param name="source">the object to convert to an encoding</param>
- <returns>the encoding</returns>
- <remarks>
- <para>
- Uses the <see cref="M:Encoding.GetEncoding(string)"/> method to
- convert the <see cref="T:System.String"/> argument to an <see cref="T:System.Text.Encoding"/>.
- </para>
- </remarks>
- <exception cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException">
- The <paramref name="source"/> object cannot be converted to the
- target type. To check for this condition use the <see cref="M:log4net.Util.TypeConverters.EncodingConverter.CanConvertFrom(System.Type)"/>
- method.
- </exception>
- </member>
- <member name="T:log4net.Util.TypeConverters.IConvertTo">
- <summary>
- Interface supported by type converters
- </summary>
- <remarks>
- <para>
- This interface supports conversion from a single type to arbitrary types.
- See <see cref="T:log4net.Util.TypeConverters.TypeConverterAttribute"/>.
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- </member>
- <member name="M:log4net.Util.TypeConverters.IConvertTo.CanConvertTo(System.Type)">
- <summary>
- Returns whether this converter can convert the object to the specified type
- </summary>
- <param name="targetType">A Type that represents the type you want to convert to</param>
- <returns>true if the conversion is possible</returns>
- <remarks>
- <para>
- Test if the type supported by this converter can be converted to the
- <paramref name="targetType"/>.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.TypeConverters.IConvertTo.ConvertTo(System.Object,System.Type)">
- <summary>
- Converts the given value object to the specified type, using the arguments
- </summary>
- <param name="source">the object to convert</param>
- <param name="targetType">The Type to convert the value parameter to</param>
- <returns>the converted object</returns>
- <remarks>
- <para>
- Converts the <paramref name="source"/> (which must be of the type supported
- by this converter) to the <paramref name="targetType"/> specified..
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Util.TypeConverters.IPAddressConverter">
- <summary>
- Supports conversion from string to <see cref="T:System.Net.IPAddress"/> type.
- </summary>
- <remarks>
- <para>
- Supports conversion from string to <see cref="T:System.Net.IPAddress"/> type.
- </para>
- </remarks>
- <seealso cref="T:log4net.Util.TypeConverters.ConverterRegistry"/>
- <seealso cref="T:log4net.Util.TypeConverters.IConvertFrom"/>
- <author>Nicko Cadell</author>
- </member>
- <member name="M:log4net.Util.TypeConverters.IPAddressConverter.CanConvertFrom(System.Type)">
- <summary>
- Can the source type be converted to the type supported by this object
- </summary>
- <param name="sourceType">the type to convert</param>
- <returns>true if the conversion is possible</returns>
- <remarks>
- <para>
- Returns <c>true</c> if the <paramref name="sourceType"/> is
- the <see cref="T:System.String"/> type.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.TypeConverters.IPAddressConverter.ConvertFrom(System.Object)">
- <summary>
- Overrides the ConvertFrom method of IConvertFrom.
- </summary>
- <param name="source">the object to convert to an IPAddress</param>
- <returns>the IPAddress</returns>
- <remarks>
- <para>
- Uses the <see cref="M:System.Net.IPAddress.Parse(System.String)"/> method to convert the
- <see cref="T:System.String"/> argument to an <see cref="T:System.Net.IPAddress"/>.
- If that fails then the string is resolved as a DNS hostname.
- </para>
- </remarks>
- <exception cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException">
- The <paramref name="source"/> object cannot be converted to the
- target type. To check for this condition use the <see cref="M:log4net.Util.TypeConverters.IPAddressConverter.CanConvertFrom(System.Type)"/>
- method.
- </exception>
- </member>
- <member name="F:log4net.Util.TypeConverters.IPAddressConverter.validIpAddressChars">
- <summary>
- Valid characters in an IPv4 or IPv6 address string. (Does not support subnets)
- </summary>
- </member>
- <member name="T:log4net.Util.TypeConverters.PatternLayoutConverter">
- <summary>
- Supports conversion from string to <see cref="T:log4net.Layout.PatternLayout"/> type.
- </summary>
- <remarks>
- <para>
- Supports conversion from string to <see cref="T:log4net.Layout.PatternLayout"/> type.
- </para>
- <para>
- The string is used as the <see cref="P:log4net.Layout.PatternLayout.ConversionPattern"/>
- of the <see cref="T:log4net.Layout.PatternLayout"/>.
- </para>
- </remarks>
- <seealso cref="T:log4net.Util.TypeConverters.ConverterRegistry"/>
- <seealso cref="T:log4net.Util.TypeConverters.IConvertFrom"/>
- <seealso cref="T:log4net.Util.TypeConverters.IConvertTo"/>
- <author>Nicko Cadell</author>
- </member>
- <member name="M:log4net.Util.TypeConverters.PatternLayoutConverter.CanConvertFrom(System.Type)">
- <summary>
- Can the source type be converted to the type supported by this object
- </summary>
- <param name="sourceType">the type to convert</param>
- <returns>true if the conversion is possible</returns>
- <remarks>
- <para>
- Returns <c>true</c> if the <paramref name="sourceType"/> is
- the <see cref="T:System.String"/> type.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.TypeConverters.PatternLayoutConverter.ConvertFrom(System.Object)">
- <summary>
- Overrides the ConvertFrom method of IConvertFrom.
- </summary>
- <param name="source">the object to convert to a PatternLayout</param>
- <returns>the PatternLayout</returns>
- <remarks>
- <para>
- Creates and returns a new <see cref="T:log4net.Layout.PatternLayout"/> using
- the <paramref name="source"/> <see cref="T:System.String"/> as the
- <see cref="P:log4net.Layout.PatternLayout.ConversionPattern"/>.
- </para>
- </remarks>
- <exception cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException">
- The <paramref name="source"/> object cannot be converted to the
- target type. To check for this condition use the <see cref="M:log4net.Util.TypeConverters.PatternLayoutConverter.CanConvertFrom(System.Type)"/>
- method.
- </exception>
- </member>
- <member name="T:log4net.Util.TypeConverters.PatternStringConverter">
- <summary>
- Convert between string and <see cref="T:log4net.Util.PatternString"/>
- </summary>
- <remarks>
- <para>
- Supports conversion from string to <see cref="T:log4net.Util.PatternString"/> type,
- and from a <see cref="T:log4net.Util.PatternString"/> type to a string.
- </para>
- <para>
- The string is used as the <see cref="P:log4net.Util.PatternString.ConversionPattern"/>
- of the <see cref="T:log4net.Util.PatternString"/>.
- </para>
- </remarks>
- <seealso cref="T:log4net.Util.TypeConverters.ConverterRegistry"/>
- <seealso cref="T:log4net.Util.TypeConverters.IConvertFrom"/>
- <seealso cref="T:log4net.Util.TypeConverters.IConvertTo"/>
- <author>Nicko Cadell</author>
- </member>
- <member name="M:log4net.Util.TypeConverters.PatternStringConverter.CanConvertTo(System.Type)">
- <summary>
- Can the target type be converted to the type supported by this object
- </summary>
- <param name="targetType">A <see cref="T:System.Type"/> that represents the type you want to convert to</param>
- <returns>true if the conversion is possible</returns>
- <remarks>
- <para>
- Returns <c>true</c> if the <paramref name="targetType"/> is
- assignable from a <see cref="T:System.String"/> type.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.TypeConverters.PatternStringConverter.ConvertTo(System.Object,System.Type)">
- <summary>
- Converts the given value object to the specified type, using the arguments
- </summary>
- <param name="source">the object to convert</param>
- <param name="targetType">The Type to convert the value parameter to</param>
- <returns>the converted object</returns>
- <remarks>
- <para>
- Uses the <see cref="M:PatternString.Format()"/> method to convert the
- <see cref="T:log4net.Util.PatternString"/> argument to a <see cref="T:System.String"/>.
- </para>
- </remarks>
- <exception cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException">
- The <paramref name="source"/> object cannot be converted to the
- <paramref name="targetType"/>. To check for this condition use the
- <see cref="M:log4net.Util.TypeConverters.PatternStringConverter.CanConvertTo(System.Type)"/> method.
- </exception>
- </member>
- <member name="M:log4net.Util.TypeConverters.PatternStringConverter.CanConvertFrom(System.Type)">
- <summary>
- Can the source type be converted to the type supported by this object
- </summary>
- <param name="sourceType">the type to convert</param>
- <returns>true if the conversion is possible</returns>
- <remarks>
- <para>
- Returns <c>true</c> if the <paramref name="sourceType"/> is
- the <see cref="T:System.String"/> type.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.TypeConverters.PatternStringConverter.ConvertFrom(System.Object)">
- <summary>
- Overrides the ConvertFrom method of IConvertFrom.
- </summary>
- <param name="source">the object to convert to a PatternString</param>
- <returns>the PatternString</returns>
- <remarks>
- <para>
- Creates and returns a new <see cref="T:log4net.Util.PatternString"/> using
- the <paramref name="source"/> <see cref="T:System.String"/> as the
- <see cref="P:log4net.Util.PatternString.ConversionPattern"/>.
- </para>
- </remarks>
- <exception cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException">
- The <paramref name="source"/> object cannot be converted to the
- target type. To check for this condition use the <see cref="M:log4net.Util.TypeConverters.PatternStringConverter.CanConvertFrom(System.Type)"/>
- method.
- </exception>
- </member>
- <member name="T:log4net.Util.TypeConverters.TypeConverter">
- <summary>
- Supports conversion from string to <see cref="T:System.Type"/> type.
- </summary>
- <remarks>
- <para>
- Supports conversion from string to <see cref="T:System.Type"/> type.
- </para>
- </remarks>
- <seealso cref="T:log4net.Util.TypeConverters.ConverterRegistry"/>
- <seealso cref="T:log4net.Util.TypeConverters.IConvertFrom"/>
- <seealso cref="T:log4net.Util.TypeConverters.IConvertTo"/>
- <author>Nicko Cadell</author>
- </member>
- <member name="M:log4net.Util.TypeConverters.TypeConverter.CanConvertFrom(System.Type)">
- <summary>
- Can the source type be converted to the type supported by this object
- </summary>
- <param name="sourceType">the type to convert</param>
- <returns>true if the conversion is possible</returns>
- <remarks>
- <para>
- Returns <c>true</c> if the <paramref name="sourceType"/> is
- the <see cref="T:System.String"/> type.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.TypeConverters.TypeConverter.ConvertFrom(System.Object)">
- <summary>
- Overrides the ConvertFrom method of IConvertFrom.
- </summary>
- <param name="source">the object to convert to a Type</param>
- <returns>the Type</returns>
- <remarks>
- <para>
- Uses the <see cref="M:Type.GetType(string,bool)"/> method to convert the
- <see cref="T:System.String"/> argument to a <see cref="T:System.Type"/>.
- Additional effort is made to locate partially specified types
- by searching the loaded assemblies.
- </para>
- </remarks>
- <exception cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException">
- The <paramref name="source"/> object cannot be converted to the
- target type. To check for this condition use the <see cref="M:log4net.Util.TypeConverters.TypeConverter.CanConvertFrom(System.Type)"/>
- method.
- </exception>
- </member>
- <member name="T:log4net.Util.TypeConverters.TypeConverterAttribute">
- <summary>
- Attribute used to associate a type converter
- </summary>
- <remarks>
- <para>
- Class and Interface level attribute that specifies a type converter
- to use with the associated type.
- </para>
- <para>
- To associate a type converter with a target type apply a
- <c>TypeConverterAttribute</c> to the target type. Specify the
- type of the type converter on the attribute.
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- <author>Gert Driesen</author>
- </member>
- <member name="F:log4net.Util.TypeConverters.TypeConverterAttribute.m_typeName">
- <summary>
- The string type name of the type converter
- </summary>
- </member>
- <member name="M:log4net.Util.TypeConverters.TypeConverterAttribute.#ctor">
- <summary>
- Default constructor
- </summary>
- <remarks>
- <para>
- Default constructor
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.TypeConverters.TypeConverterAttribute.#ctor(System.String)">
- <summary>
- Create a new type converter attribute for the specified type name
- </summary>
- <param name="typeName">The string type name of the type converter</param>
- <remarks>
- <para>
- The type specified must implement the <see cref="T:log4net.Util.TypeConverters.IConvertFrom"/>
- or the <see cref="T:log4net.Util.TypeConverters.IConvertTo"/> interfaces.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.TypeConverters.TypeConverterAttribute.#ctor(System.Type)">
- <summary>
- Create a new type converter attribute for the specified type
- </summary>
- <param name="converterType">The type of the type converter</param>
- <remarks>
- <para>
- The type specified must implement the <see cref="T:log4net.Util.TypeConverters.IConvertFrom"/>
- or the <see cref="T:log4net.Util.TypeConverters.IConvertTo"/> interfaces.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Util.TypeConverters.TypeConverterAttribute.ConverterTypeName">
- <summary>
- The string type name of the type converter
- </summary>
- <value>
- The string type name of the type converter
- </value>
- <remarks>
- <para>
- The type specified must implement the <see cref="T:log4net.Util.TypeConverters.IConvertFrom"/>
- or the <see cref="T:log4net.Util.TypeConverters.IConvertTo"/> interfaces.
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Util.AppenderAttachedImpl">
- <summary>
- A straightforward implementation of the <see cref="T:log4net.Core.IAppenderAttachable"/> interface.
- </summary>
- <remarks>
- <para>
- This is the default implementation of the <see cref="T:log4net.Core.IAppenderAttachable"/>
- interface. Implementors of the <see cref="T:log4net.Core.IAppenderAttachable"/> interface
- should aggregate an instance of this type.
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- <author>Gert Driesen</author>
- </member>
- <member name="M:log4net.Util.AppenderAttachedImpl.#ctor">
- <summary>
- Constructor
- </summary>
- <remarks>
- <para>
- Initializes a new instance of the <see cref="T:log4net.Util.AppenderAttachedImpl"/> class.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.AppenderAttachedImpl.AppendLoopOnAppenders(log4net.Core.LoggingEvent)">
- <summary>
- Append on on all attached appenders.
- </summary>
- <param name="loggingEvent">The event being logged.</param>
- <returns>The number of appenders called.</returns>
- <remarks>
- <para>
- Calls the <see cref="M:log4net.Appender.IAppender.DoAppend(log4net.Core.LoggingEvent)"/> method on all
- attached appenders.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.AppenderAttachedImpl.AppendLoopOnAppenders(log4net.Core.LoggingEvent[])">
- <summary>
- Append on on all attached appenders.
- </summary>
- <param name="loggingEvents">The array of events being logged.</param>
- <returns>The number of appenders called.</returns>
- <remarks>
- <para>
- Calls the <see cref="M:log4net.Appender.IAppender.DoAppend(log4net.Core.LoggingEvent)"/> method on all
- attached appenders.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.AppenderAttachedImpl.CallAppend(log4net.Appender.IAppender,log4net.Core.LoggingEvent[])">
- <summary>
- Calls the DoAppende method on the <see cref="T:log4net.Appender.IAppender"/> with
- the <see cref="T:log4net.Core.LoggingEvent"/> objects supplied.
- </summary>
- <param name="appender">The appender</param>
- <param name="loggingEvents">The events</param>
- <remarks>
- <para>
- If the <paramref name="appender"/> supports the <see cref="T:log4net.Appender.IBulkAppender"/>
- interface then the <paramref name="loggingEvents"/> will be passed
- through using that interface. Otherwise the <see cref="T:log4net.Core.LoggingEvent"/>
- objects in the array will be passed one at a time.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.AppenderAttachedImpl.AddAppender(log4net.Appender.IAppender)">
- <summary>
- Attaches an appender.
- </summary>
- <param name="newAppender">The appender to add.</param>
- <remarks>
- <para>
- If the appender is already in the list it won't be added again.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.AppenderAttachedImpl.GetAppender(System.String)">
- <summary>
- Gets an attached appender with the specified name.
- </summary>
- <param name="name">The name of the appender to get.</param>
- <returns>
- The appender with the name specified, or <c>null</c> if no appender with the
- specified name is found.
- </returns>
- <remarks>
- <para>
- Lookup an attached appender by name.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.AppenderAttachedImpl.RemoveAllAppenders">
- <summary>
- Removes all attached appenders.
- </summary>
- <remarks>
- <para>
- Removes and closes all attached appenders
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.AppenderAttachedImpl.RemoveAppender(log4net.Appender.IAppender)">
- <summary>
- Removes the specified appender from the list of attached appenders.
- </summary>
- <param name="appender">The appender to remove.</param>
- <returns>The appender removed from the list</returns>
- <remarks>
- <para>
- The appender removed is not closed.
- If you are discarding the appender you must call
- <see cref="M:log4net.Appender.IAppender.Close"/> on the appender removed.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.AppenderAttachedImpl.RemoveAppender(System.String)">
- <summary>
- Removes the appender with the specified name from the list of appenders.
- </summary>
- <param name="name">The name of the appender to remove.</param>
- <returns>The appender removed from the list</returns>
- <remarks>
- <para>
- The appender removed is not closed.
- If you are discarding the appender you must call
- <see cref="M:log4net.Appender.IAppender.Close"/> on the appender removed.
- </para>
- </remarks>
- </member>
- <member name="F:log4net.Util.AppenderAttachedImpl.m_appenderList">
- <summary>
- List of appenders
- </summary>
- </member>
- <member name="F:log4net.Util.AppenderAttachedImpl.m_appenderArray">
- <summary>
- Array of appenders, used to cache the m_appenderList
- </summary>
- </member>
- <member name="F:log4net.Util.AppenderAttachedImpl.declaringType">
- <summary>
- The fully qualified type of the AppenderAttachedImpl class.
- </summary>
- <remarks>
- Used by the internal logger to record the Type of the
- log message.
- </remarks>
- </member>
- <member name="P:log4net.Util.AppenderAttachedImpl.Appenders">
- <summary>
- Gets all attached appenders.
- </summary>
- <returns>
- A collection of attached appenders, or <c>null</c> if there
- are no attached appenders.
- </returns>
- <remarks>
- <para>
- The read only collection of all currently attached appenders.
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Util.CompositeProperties">
- <summary>
- This class aggregates several PropertiesDictionary collections together.
- </summary>
- <remarks>
- <para>
- Provides a dictionary style lookup over an ordered list of
- <see cref="T:log4net.Util.PropertiesDictionary"/> collections.
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- </member>
- <member name="M:log4net.Util.CompositeProperties.#ctor">
- <summary>
- Constructor
- </summary>
- <remarks>
- <para>
- Initializes a new instance of the <see cref="T:log4net.Util.CompositeProperties"/> class.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.CompositeProperties.Add(log4net.Util.ReadOnlyPropertiesDictionary)">
- <summary>
- Add a Properties Dictionary to this composite collection
- </summary>
- <param name="properties">the properties to add</param>
- <remarks>
- <para>
- Properties dictionaries added first take precedence over dictionaries added
- later.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.CompositeProperties.Flatten">
- <summary>
- Flatten this composite collection into a single properties dictionary
- </summary>
- <returns>the flattened dictionary</returns>
- <remarks>
- <para>
- Reduces the collection of ordered dictionaries to a single dictionary
- containing the resultant values for the keys.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Util.CompositeProperties.Item(System.String)">
- <summary>
- Gets the value of a property
- </summary>
- <value>
- The value for the property with the specified key
- </value>
- <remarks>
- <para>
- Looks up the value for the <paramref name="key"/> specified.
- The <see cref="T:log4net.Util.PropertiesDictionary"/> collections are searched
- in the order in which they were added to this collection. The value
- returned is the value held by the first collection that contains
- the specified key.
- </para>
- <para>
- If none of the collections contain the specified key then
- <c>null</c> is returned.
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Util.ContextPropertiesBase">
- <summary>
- Base class for Context Properties implementations
- </summary>
- <remarks>
- <para>
- This class defines a basic property get set accessor
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- </member>
- <member name="P:log4net.Util.ContextPropertiesBase.Item(System.String)">
- <summary>
- Gets or sets the value of a property
- </summary>
- <value>
- The value for the property with the specified key
- </value>
- <remarks>
- <para>
- Gets or sets the value of a property
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Util.ConverterInfo">
- <summary>
- Wrapper class used to map converter names to converter types
- </summary>
- <remarks>
- <para>
- Pattern converter info class used during configuration by custom
- PatternString and PatternLayer converters.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.ConverterInfo.#ctor">
- <summary>
- default constructor
- </summary>
- </member>
- <member name="M:log4net.Util.ConverterInfo.AddProperty(log4net.Util.PropertyEntry)">
- <summary>
-
- </summary>
- <param name="entry"></param>
- </member>
- <member name="P:log4net.Util.ConverterInfo.Name">
- <summary>
- Gets or sets the name of the conversion pattern
- </summary>
- <remarks>
- <para>
- The name of the pattern in the format string
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Util.ConverterInfo.Type">
- <summary>
- Gets or sets the type of the converter
- </summary>
- <remarks>
- <para>
- The value specified must extend the
- <see cref="T:log4net.Util.PatternConverter"/> type.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Util.ConverterInfo.Properties">
- <summary>
-
- </summary>
- </member>
- <member name="T:log4net.Util.CountingQuietTextWriter">
- <summary>
- Subclass of <see cref="T:log4net.Util.QuietTextWriter"/> that maintains a count of
- the number of bytes written.
- </summary>
- <remarks>
- <para>
- This writer counts the number of bytes written.
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- <author>Gert Driesen</author>
- </member>
- <member name="T:log4net.Util.QuietTextWriter">
- <summary>
- <see cref="T:System.IO.TextWriter"/> that does not leak exceptions
- </summary>
- <remarks>
- <para>
- <see cref="T:log4net.Util.QuietTextWriter"/> does not throw exceptions when things go wrong.
- Instead, it delegates error handling to its <see cref="T:log4net.Core.IErrorHandler"/>.
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- <author>Gert Driesen</author>
- </member>
- <member name="T:log4net.Util.TextWriterAdapter">
- <summary>
- Adapter that extends <see cref="T:System.IO.TextWriter"/> and forwards all
- messages to an instance of <see cref="T:System.IO.TextWriter"/>.
- </summary>
- <remarks>
- <para>
- Adapter that extends <see cref="T:System.IO.TextWriter"/> and forwards all
- messages to an instance of <see cref="T:System.IO.TextWriter"/>.
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- </member>
- <member name="F:log4net.Util.TextWriterAdapter.m_writer">
- <summary>
- The writer to forward messages to
- </summary>
- </member>
- <member name="M:log4net.Util.TextWriterAdapter.#ctor(System.IO.TextWriter)">
- <summary>
- Create an instance of <see cref="T:log4net.Util.TextWriterAdapter"/> that forwards all
- messages to a <see cref="T:System.IO.TextWriter"/>.
- </summary>
- <param name="writer">The <see cref="T:System.IO.TextWriter"/> to forward to</param>
- <remarks>
- <para>
- Create an instance of <see cref="T:log4net.Util.TextWriterAdapter"/> that forwards all
- messages to a <see cref="T:System.IO.TextWriter"/>.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.TextWriterAdapter.Close">
- <summary>
- Closes the writer and releases any system resources associated with the writer
- </summary>
- <remarks>
- <para>
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.TextWriterAdapter.Dispose(System.Boolean)">
- <summary>
- Dispose this writer
- </summary>
- <param name="disposing">flag indicating if we are being disposed</param>
- <remarks>
- <para>
- Dispose this writer
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.TextWriterAdapter.Flush">
- <summary>
- Flushes any buffered output
- </summary>
- <remarks>
- <para>
- Clears all buffers for the writer and causes any buffered data to be written
- to the underlying device
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.TextWriterAdapter.Write(System.Char)">
- <summary>
- Writes a character to the wrapped TextWriter
- </summary>
- <param name="value">the value to write to the TextWriter</param>
- <remarks>
- <para>
- Writes a character to the wrapped TextWriter
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.TextWriterAdapter.Write(System.Char[],System.Int32,System.Int32)">
- <summary>
- Writes a character buffer to the wrapped TextWriter
- </summary>
- <param name="buffer">the data buffer</param>
- <param name="index">the start index</param>
- <param name="count">the number of characters to write</param>
- <remarks>
- <para>
- Writes a character buffer to the wrapped TextWriter
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.TextWriterAdapter.Write(System.String)">
- <summary>
- Writes a string to the wrapped TextWriter
- </summary>
- <param name="value">the value to write to the TextWriter</param>
- <remarks>
- <para>
- Writes a string to the wrapped TextWriter
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Util.TextWriterAdapter.Writer">
- <summary>
- Gets or sets the underlying <see cref="T:System.IO.TextWriter"/>.
- </summary>
- <value>
- The underlying <see cref="T:System.IO.TextWriter"/>.
- </value>
- <remarks>
- <para>
- Gets or sets the underlying <see cref="T:System.IO.TextWriter"/>.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Util.TextWriterAdapter.Encoding">
- <summary>
- The Encoding in which the output is written
- </summary>
- <value>
- The <see cref="P:log4net.Util.TextWriterAdapter.Encoding"/>
- </value>
- <remarks>
- <para>
- The Encoding in which the output is written
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Util.TextWriterAdapter.FormatProvider">
- <summary>
- Gets an object that controls formatting
- </summary>
- <value>
- The format provider
- </value>
- <remarks>
- <para>
- Gets an object that controls formatting
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Util.TextWriterAdapter.NewLine">
- <summary>
- Gets or sets the line terminator string used by the TextWriter
- </summary>
- <value>
- The line terminator to use
- </value>
- <remarks>
- <para>
- Gets or sets the line terminator string used by the TextWriter
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.QuietTextWriter.#ctor(System.IO.TextWriter,log4net.Core.IErrorHandler)">
- <summary>
- Constructor
- </summary>
- <param name="writer">the writer to actually write to</param>
- <param name="errorHandler">the error handler to report error to</param>
- <remarks>
- <para>
- Create a new QuietTextWriter using a writer and error handler
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.QuietTextWriter.Write(System.Char)">
- <summary>
- Writes a character to the underlying writer
- </summary>
- <param name="value">the char to write</param>
- <remarks>
- <para>
- Writes a character to the underlying writer
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.QuietTextWriter.Write(System.Char[],System.Int32,System.Int32)">
- <summary>
- Writes a buffer to the underlying writer
- </summary>
- <param name="buffer">the buffer to write</param>
- <param name="index">the start index to write from</param>
- <param name="count">the number of characters to write</param>
- <remarks>
- <para>
- Writes a buffer to the underlying writer
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.QuietTextWriter.Write(System.String)">
- <summary>
- Writes a string to the output.
- </summary>
- <param name="value">The string data to write to the output.</param>
- <remarks>
- <para>
- Writes a string to the output.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.QuietTextWriter.Close">
- <summary>
- Closes the underlying output writer.
- </summary>
- <remarks>
- <para>
- Closes the underlying output writer.
- </para>
- </remarks>
- </member>
- <member name="F:log4net.Util.QuietTextWriter.m_errorHandler">
- <summary>
- The error handler instance to pass all errors to
- </summary>
- </member>
- <member name="F:log4net.Util.QuietTextWriter.m_closed">
- <summary>
- Flag to indicate if this writer is closed
- </summary>
- </member>
- <member name="P:log4net.Util.QuietTextWriter.ErrorHandler">
- <summary>
- Gets or sets the error handler that all errors are passed to.
- </summary>
- <value>
- The error handler that all errors are passed to.
- </value>
- <remarks>
- <para>
- Gets or sets the error handler that all errors are passed to.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Util.QuietTextWriter.Closed">
- <summary>
- Gets a value indicating whether this writer is closed.
- </summary>
- <value>
- <c>true</c> if this writer is closed, otherwise <c>false</c>.
- </value>
- <remarks>
- <para>
- Gets a value indicating whether this writer is closed.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.CountingQuietTextWriter.#ctor(System.IO.TextWriter,log4net.Core.IErrorHandler)">
- <summary>
- Constructor
- </summary>
- <param name="writer">The <see cref="T:System.IO.TextWriter"/> to actually write to.</param>
- <param name="errorHandler">The <see cref="T:log4net.Core.IErrorHandler"/> to report errors to.</param>
- <remarks>
- <para>
- Creates a new instance of the <see cref="T:log4net.Util.CountingQuietTextWriter"/> class
- with the specified <see cref="T:System.IO.TextWriter"/> and <see cref="T:log4net.Core.IErrorHandler"/>.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.CountingQuietTextWriter.Write(System.Char)">
- <summary>
- Writes a character to the underlying writer and counts the number of bytes written.
- </summary>
- <param name="value">the char to write</param>
- <remarks>
- <para>
- Overrides implementation of <see cref="T:log4net.Util.QuietTextWriter"/>. Counts
- the number of bytes written.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.CountingQuietTextWriter.Write(System.Char[],System.Int32,System.Int32)">
- <summary>
- Writes a buffer to the underlying writer and counts the number of bytes written.
- </summary>
- <param name="buffer">the buffer to write</param>
- <param name="index">the start index to write from</param>
- <param name="count">the number of characters to write</param>
- <remarks>
- <para>
- Overrides implementation of <see cref="T:log4net.Util.QuietTextWriter"/>. Counts
- the number of bytes written.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.CountingQuietTextWriter.Write(System.String)">
- <summary>
- Writes a string to the output and counts the number of bytes written.
- </summary>
- <param name="str">The string data to write to the output.</param>
- <remarks>
- <para>
- Overrides implementation of <see cref="T:log4net.Util.QuietTextWriter"/>. Counts
- the number of bytes written.
- </para>
- </remarks>
- </member>
- <member name="F:log4net.Util.CountingQuietTextWriter.m_countBytes">
- <summary>
- Total number of bytes written.
- </summary>
- </member>
- <member name="P:log4net.Util.CountingQuietTextWriter.Count">
- <summary>
- Gets or sets the total number of bytes written.
- </summary>
- <value>
- The total number of bytes written.
- </value>
- <remarks>
- <para>
- Gets or sets the total number of bytes written.
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Util.CyclicBuffer">
- <summary>
- A fixed size rolling buffer of logging events.
- </summary>
- <remarks>
- <para>
- An array backed fixed size leaky bucket.
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- <author>Gert Driesen</author>
- </member>
- <member name="M:log4net.Util.CyclicBuffer.#ctor(System.Int32)">
- <summary>
- Constructor
- </summary>
- <param name="maxSize">The maximum number of logging events in the buffer.</param>
- <remarks>
- <para>
- Initializes a new instance of the <see cref="T:log4net.Util.CyclicBuffer"/> class with
- the specified maximum number of buffered logging events.
- </para>
- </remarks>
- <exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="maxSize"/> argument is not a positive integer.</exception>
- </member>
- <member name="M:log4net.Util.CyclicBuffer.Append(log4net.Core.LoggingEvent)">
- <summary>
- Appends a <paramref name="loggingEvent"/> to the buffer.
- </summary>
- <param name="loggingEvent">The event to append to the buffer.</param>
- <returns>The event discarded from the buffer, if the buffer is full, otherwise <c>null</c>.</returns>
- <remarks>
- <para>
- Append an event to the buffer. If the buffer still contains free space then
- <c>null</c> is returned. If the buffer is full then an event will be dropped
- to make space for the new event, the event dropped is returned.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.CyclicBuffer.PopOldest">
- <summary>
- Get and remove the oldest event in the buffer.
- </summary>
- <returns>The oldest logging event in the buffer</returns>
- <remarks>
- <para>
- Gets the oldest (first) logging event in the buffer and removes it
- from the buffer.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.CyclicBuffer.PopAll">
- <summary>
- Pops all the logging events from the buffer into an array.
- </summary>
- <returns>An array of all the logging events in the buffer.</returns>
- <remarks>
- <para>
- Get all the events in the buffer and clear the buffer.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.CyclicBuffer.Clear">
- <summary>
- Clear the buffer
- </summary>
- <remarks>
- <para>
- Clear the buffer of all events. The events in the buffer are lost.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Util.CyclicBuffer.Item(System.Int32)">
- <summary>
- Gets the <paramref name="i"/>th oldest event currently in the buffer.
- </summary>
- <value>The <paramref name="i"/>th oldest event currently in the buffer.</value>
- <remarks>
- <para>
- If <paramref name="i"/> is outside the range 0 to the number of events
- currently in the buffer, then <c>null</c> is returned.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Util.CyclicBuffer.MaxSize">
- <summary>
- Gets the maximum size of the buffer.
- </summary>
- <value>The maximum size of the buffer.</value>
- <remarks>
- <para>
- Gets the maximum size of the buffer
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Util.CyclicBuffer.Length">
- <summary>
- Gets the number of logging events in the buffer.
- </summary>
- <value>The number of logging events in the buffer.</value>
- <remarks>
- <para>
- This number is guaranteed to be in the range 0 to <see cref="P:log4net.Util.CyclicBuffer.MaxSize"/>
- (inclusive).
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Util.EmptyCollection">
- <summary>
- An always empty <see cref="T:System.Collections.ICollection"/>.
- </summary>
- <remarks>
- <para>
- A singleton implementation of the <see cref="T:System.Collections.ICollection"/>
- interface that always represents an empty collection.
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- <author>Gert Driesen</author>
- </member>
- <member name="M:log4net.Util.EmptyCollection.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:log4net.Util.EmptyCollection"/> class.
- </summary>
- <remarks>
- <para>
- Uses a private access modifier to enforce the singleton pattern.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.EmptyCollection.CopyTo(System.Array,System.Int32)">
- <summary>
- Copies the elements of the <see cref="T:System.Collections.ICollection"/> to an
- <see cref="T:System.Array"/>, starting at a particular Array index.
- </summary>
- <param name="array">The one-dimensional <see cref="T:System.Array"/>
- that is the destination of the elements copied from
- <see cref="T:System.Collections.ICollection"/>. The Array must have zero-based
- indexing.</param>
- <param name="index">The zero-based index in array at which
- copying begins.</param>
- <remarks>
- <para>
- As the collection is empty no values are copied into the array.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.EmptyCollection.GetEnumerator">
- <summary>
- Returns an enumerator that can iterate through a collection.
- </summary>
- <returns>
- An <see cref="T:System.Collections.IEnumerator"/> that can be used to
- iterate through the collection.
- </returns>
- <remarks>
- <para>
- As the collection is empty a <see cref="T:log4net.Util.NullEnumerator"/> is returned.
- </para>
- </remarks>
- </member>
- <member name="F:log4net.Util.EmptyCollection.s_instance">
- <summary>
- The singleton instance of the empty collection.
- </summary>
- </member>
- <member name="P:log4net.Util.EmptyCollection.Instance">
- <summary>
- Gets the singleton instance of the empty collection.
- </summary>
- <returns>The singleton instance of the empty collection.</returns>
- <remarks>
- <para>
- Gets the singleton instance of the empty collection.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Util.EmptyCollection.IsSynchronized">
- <summary>
- Gets a value indicating if access to the <see cref="T:System.Collections.ICollection"/> is synchronized (thread-safe).
- </summary>
- <value>
- <b>true</b> if access to the <see cref="T:System.Collections.ICollection"/> is synchronized (thread-safe); otherwise, <b>false</b>.
- </value>
- <remarks>
- <para>
- For the <see cref="T:log4net.Util.EmptyCollection"/> this property is always <c>true</c>.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Util.EmptyCollection.Count">
- <summary>
- Gets the number of elements contained in the <see cref="T:System.Collections.ICollection"/>.
- </summary>
- <value>
- The number of elements contained in the <see cref="T:System.Collections.ICollection"/>.
- </value>
- <remarks>
- <para>
- As the collection is empty the <see cref="P:log4net.Util.EmptyCollection.Count"/> is always <c>0</c>.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Util.EmptyCollection.SyncRoot">
- <summary>
- Gets an object that can be used to synchronize access to the <see cref="T:System.Collections.ICollection"/>.
- </summary>
- <value>
- An object that can be used to synchronize access to the <see cref="T:System.Collections.ICollection"/>.
- </value>
- <remarks>
- <para>
- As the collection is empty and thread safe and synchronized this instance is also
- the <see cref="P:log4net.Util.EmptyCollection.SyncRoot"/> object.
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Util.EmptyDictionary">
- <summary>
- An always empty <see cref="T:System.Collections.IDictionary"/>.
- </summary>
- <remarks>
- <para>
- A singleton implementation of the <see cref="T:System.Collections.IDictionary"/>
- interface that always represents an empty collection.
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- <author>Gert Driesen</author>
- </member>
- <member name="M:log4net.Util.EmptyDictionary.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:log4net.Util.EmptyDictionary"/> class.
- </summary>
- <remarks>
- <para>
- Uses a private access modifier to enforce the singleton pattern.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.EmptyDictionary.CopyTo(System.Array,System.Int32)">
- <summary>
- Copies the elements of the <see cref="T:System.Collections.ICollection"/> to an
- <see cref="T:System.Array"/>, starting at a particular Array index.
- </summary>
- <param name="array">The one-dimensional <see cref="T:System.Array"/>
- that is the destination of the elements copied from
- <see cref="T:System.Collections.ICollection"/>. The Array must have zero-based
- indexing.</param>
- <param name="index">The zero-based index in array at which
- copying begins.</param>
- <remarks>
- <para>
- As the collection is empty no values are copied into the array.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.EmptyDictionary.System#Collections#IEnumerable#GetEnumerator">
- <summary>
- Returns an enumerator that can iterate through a collection.
- </summary>
- <returns>
- An <see cref="T:System.Collections.IEnumerator"/> that can be used to
- iterate through the collection.
- </returns>
- <remarks>
- <para>
- As the collection is empty a <see cref="T:log4net.Util.NullEnumerator"/> is returned.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.EmptyDictionary.Add(System.Object,System.Object)">
- <summary>
- Adds an element with the provided key and value to the
- <see cref="T:log4net.Util.EmptyDictionary"/>.
- </summary>
- <param name="key">The <see cref="T:System.Object"/> to use as the key of the element to add.</param>
- <param name="value">The <see cref="T:System.Object"/> to use as the value of the element to add.</param>
- <remarks>
- <para>
- As the collection is empty no new values can be added. A <see cref="T:System.InvalidOperationException"/>
- is thrown if this method is called.
- </para>
- </remarks>
- <exception cref="T:System.InvalidOperationException">This dictionary is always empty and cannot be modified.</exception>
- </member>
- <member name="M:log4net.Util.EmptyDictionary.Clear">
- <summary>
- Removes all elements from the <see cref="T:log4net.Util.EmptyDictionary"/>.
- </summary>
- <remarks>
- <para>
- As the collection is empty no values can be removed. A <see cref="T:System.InvalidOperationException"/>
- is thrown if this method is called.
- </para>
- </remarks>
- <exception cref="T:System.InvalidOperationException">This dictionary is always empty and cannot be modified.</exception>
- </member>
- <member name="M:log4net.Util.EmptyDictionary.Contains(System.Object)">
- <summary>
- Determines whether the <see cref="T:log4net.Util.EmptyDictionary"/> contains an element
- with the specified key.
- </summary>
- <param name="key">The key to locate in the <see cref="T:log4net.Util.EmptyDictionary"/>.</param>
- <returns><c>false</c></returns>
- <remarks>
- <para>
- As the collection is empty the <see cref="M:log4net.Util.EmptyDictionary.Contains(System.Object)"/> method always returns <c>false</c>.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.EmptyDictionary.GetEnumerator">
- <summary>
- Returns an enumerator that can iterate through a collection.
- </summary>
- <returns>
- An <see cref="T:System.Collections.IEnumerator"/> that can be used to
- iterate through the collection.
- </returns>
- <remarks>
- <para>
- As the collection is empty a <see cref="T:log4net.Util.NullEnumerator"/> is returned.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.EmptyDictionary.Remove(System.Object)">
- <summary>
- Removes the element with the specified key from the <see cref="T:log4net.Util.EmptyDictionary"/>.
- </summary>
- <param name="key">The key of the element to remove.</param>
- <remarks>
- <para>
- As the collection is empty no values can be removed. A <see cref="T:System.InvalidOperationException"/>
- is thrown if this method is called.
- </para>
- </remarks>
- <exception cref="T:System.InvalidOperationException">This dictionary is always empty and cannot be modified.</exception>
- </member>
- <member name="F:log4net.Util.EmptyDictionary.s_instance">
- <summary>
- The singleton instance of the empty dictionary.
- </summary>
- </member>
- <member name="P:log4net.Util.EmptyDictionary.Instance">
- <summary>
- Gets the singleton instance of the <see cref="T:log4net.Util.EmptyDictionary"/>.
- </summary>
- <returns>The singleton instance of the <see cref="T:log4net.Util.EmptyDictionary"/>.</returns>
- <remarks>
- <para>
- Gets the singleton instance of the <see cref="T:log4net.Util.EmptyDictionary"/>.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Util.EmptyDictionary.IsSynchronized">
- <summary>
- Gets a value indicating if access to the <see cref="T:System.Collections.ICollection"/> is synchronized (thread-safe).
- </summary>
- <value>
- <b>true</b> if access to the <see cref="T:System.Collections.ICollection"/> is synchronized (thread-safe); otherwise, <b>false</b>.
- </value>
- <remarks>
- <para>
- For the <see cref="T:log4net.Util.EmptyCollection"/> this property is always <b>true</b>.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Util.EmptyDictionary.Count">
- <summary>
- Gets the number of elements contained in the <see cref="T:System.Collections.ICollection"/>
- </summary>
- <value>
- The number of elements contained in the <see cref="T:System.Collections.ICollection"/>.
- </value>
- <remarks>
- <para>
- As the collection is empty the <see cref="P:log4net.Util.EmptyDictionary.Count"/> is always <c>0</c>.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Util.EmptyDictionary.SyncRoot">
- <summary>
- Gets an object that can be used to synchronize access to the <see cref="T:System.Collections.ICollection"/>.
- </summary>
- <value>
- An object that can be used to synchronize access to the <see cref="T:System.Collections.ICollection"/>.
- </value>
- <remarks>
- <para>
- As the collection is empty and thread safe and synchronized this instance is also
- the <see cref="P:log4net.Util.EmptyDictionary.SyncRoot"/> object.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Util.EmptyDictionary.IsFixedSize">
- <summary>
- Gets a value indicating whether the <see cref="T:log4net.Util.EmptyDictionary"/> has a fixed size.
- </summary>
- <value><c>true</c></value>
- <remarks>
- <para>
- As the collection is empty <see cref="P:log4net.Util.EmptyDictionary.IsFixedSize"/> always returns <c>true</c>.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Util.EmptyDictionary.IsReadOnly">
- <summary>
- Gets a value indicating whether the <see cref="T:log4net.Util.EmptyDictionary"/> is read-only.
- </summary>
- <value><c>true</c></value>
- <remarks>
- <para>
- As the collection is empty <see cref="P:log4net.Util.EmptyDictionary.IsReadOnly"/> always returns <c>true</c>.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Util.EmptyDictionary.Keys">
- <summary>
- Gets an <see cref="T:System.Collections.ICollection"/> containing the keys of the <see cref="T:log4net.Util.EmptyDictionary"/>.
- </summary>
- <value>An <see cref="T:System.Collections.ICollection"/> containing the keys of the <see cref="T:log4net.Util.EmptyDictionary"/>.</value>
- <remarks>
- <para>
- As the collection is empty a <see cref="T:log4net.Util.EmptyCollection"/> is returned.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Util.EmptyDictionary.Values">
- <summary>
- Gets an <see cref="T:System.Collections.ICollection"/> containing the values of the <see cref="T:log4net.Util.EmptyDictionary"/>.
- </summary>
- <value>An <see cref="T:System.Collections.ICollection"/> containing the values of the <see cref="T:log4net.Util.EmptyDictionary"/>.</value>
- <remarks>
- <para>
- As the collection is empty a <see cref="T:log4net.Util.EmptyCollection"/> is returned.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Util.EmptyDictionary.Item(System.Object)">
- <summary>
- Gets or sets the element with the specified key.
- </summary>
- <param name="key">The key of the element to get or set.</param>
- <value><c>null</c></value>
- <remarks>
- <para>
- As the collection is empty no values can be looked up or stored.
- If the index getter is called then <c>null</c> is returned.
- A <see cref="T:System.InvalidOperationException"/> is thrown if the setter is called.
- </para>
- </remarks>
- <exception cref="T:System.InvalidOperationException">This dictionary is always empty and cannot be modified.</exception>
- </member>
- <member name="T:log4net.Util.FormattingInfo">
- <summary>
- Contain the information obtained when parsing formatting modifiers
- in conversion modifiers.
- </summary>
- <remarks>
- <para>
- Holds the formatting information extracted from the format string by
- the <see cref="T:log4net.Util.PatternParser"/>. This is used by the <see cref="T:log4net.Util.PatternConverter"/>
- objects when rendering the output.
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- <author>Gert Driesen</author>
- </member>
- <member name="M:log4net.Util.FormattingInfo.#ctor">
- <summary>
- Defaut Constructor
- </summary>
- <remarks>
- <para>
- Initializes a new instance of the <see cref="T:log4net.Util.FormattingInfo"/> class.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.FormattingInfo.#ctor(System.Int32,System.Int32,System.Boolean)">
- <summary>
- Constructor
- </summary>
- <remarks>
- <para>
- Initializes a new instance of the <see cref="T:log4net.Util.FormattingInfo"/> class
- with the specified parameters.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Util.FormattingInfo.Min">
- <summary>
- Gets or sets the minimum value.
- </summary>
- <value>
- The minimum value.
- </value>
- <remarks>
- <para>
- Gets or sets the minimum value.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Util.FormattingInfo.Max">
- <summary>
- Gets or sets the maximum value.
- </summary>
- <value>
- The maximum value.
- </value>
- <remarks>
- <para>
- Gets or sets the maximum value.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Util.FormattingInfo.LeftAlign">
- <summary>
- Gets or sets a flag indicating whether left align is enabled
- or not.
- </summary>
- <value>
- A flag indicating whether left align is enabled or not.
- </value>
- <remarks>
- <para>
- Gets or sets a flag indicating whether left align is enabled or not.
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Util.GlobalContextProperties">
- <summary>
- Implementation of Properties collection for the <see cref="T:log4net.GlobalContext"/>
- </summary>
- <remarks>
- <para>
- This class implements a properties collection that is thread safe and supports both
- storing properties and capturing a read only copy of the current propertied.
- </para>
- <para>
- This class is optimized to the scenario where the properties are read frequently
- and are modified infrequently.
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- </member>
- <member name="F:log4net.Util.GlobalContextProperties.m_readOnlyProperties">
- <summary>
- The read only copy of the properties.
- </summary>
- <remarks>
- <para>
- This variable is declared <c>volatile</c> to prevent the compiler and JIT from
- reordering reads and writes of this thread performed on different threads.
- </para>
- </remarks>
- </member>
- <member name="F:log4net.Util.GlobalContextProperties.m_syncRoot">
- <summary>
- Lock object used to synchronize updates within this instance
- </summary>
- </member>
- <member name="M:log4net.Util.GlobalContextProperties.#ctor">
- <summary>
- Constructor
- </summary>
- <remarks>
- <para>
- Initializes a new instance of the <see cref="T:log4net.Util.GlobalContextProperties"/> class.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.GlobalContextProperties.Remove(System.String)">
- <summary>
- Remove a property from the global context
- </summary>
- <param name="key">the key for the entry to remove</param>
- <remarks>
- <para>
- Removing an entry from the global context properties is relatively expensive compared
- with reading a value.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.GlobalContextProperties.Clear">
- <summary>
- Clear the global context properties
- </summary>
- </member>
- <member name="M:log4net.Util.GlobalContextProperties.GetReadOnlyProperties">
- <summary>
- Get a readonly immutable copy of the properties
- </summary>
- <returns>the current global context properties</returns>
- <remarks>
- <para>
- This implementation is fast because the GlobalContextProperties class
- stores a readonly copy of the properties.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Util.GlobalContextProperties.Item(System.String)">
- <summary>
- Gets or sets the value of a property
- </summary>
- <value>
- The value for the property with the specified key
- </value>
- <remarks>
- <para>
- Reading the value for a key is faster than setting the value.
- When the value is written a new read only copy of
- the properties is created.
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Util.ILogExtensions">
- <summary>
- The static class ILogExtensions contains a set of widely used
- methods that ease the interaction with the ILog interface implementations.
- </summary>
- <remarks>
- <para>
- This class contains methods for logging at different levels and checks the
- properties for determining if those logging levels are enabled in the current
- configuration.
- </para>
- </remarks>
- <example>Simple example of logging messages
- <code lang="C#">
- using log4net.Util;
-
- ILog log = LogManager.GetLogger("application-log");
-
- log.InfoExt("Application Start");
- log.DebugExt("This is a debug message");
- </code>
- </example>
- </member>
- <member name="F:log4net.Util.ILogExtensions.declaringType">
- <summary>
- The fully qualified type of the Logger class.
- </summary>
- </member>
- <member name="M:log4net.Util.ILogExtensions.DebugExt(log4net.ILog,System.Func{System.Object})">
- <summary>
- Log a message object with the <see cref="F:log4net.Core.Level.Debug"/> level.
- </summary>
- <param name="logger">The logger on which the message is logged.</param>
- <param name="callback">The lambda expression that gets the object to log.</param>
- <remarks>
- <para>
- This method first checks if this logger is <c>INFO</c>
- enabled by reading the value <seealso cref="P:log4net.ILog.IsDebugEnabled"/> property.
- This check happens always and does not depend on the <seealso cref="T:log4net.ILog"/>
- implementation. If this logger is <c>INFO</c> enabled, then it converts
- the message object (retrieved by invocation of the provided callback) to a
- string by invoking the appropriate <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>.
- It then proceeds to call all the registered appenders in this logger
- and also higher in the hierarchy depending on the value of
- the additivity flag.
- </para>
- <para><b>WARNING</b> Note that passing an <see cref="T:System.Exception"/>
- to this method will print the name of the <see cref="T:System.Exception"/>
- but no stack trace. To print a stack trace use the
- <see cref="M:log4net.Util.ILogExtensions.DebugExt(log4net.ILog,System.Func{System.Object},System.Exception)"/> form instead.
- </para>
- </remarks>
- <seealso cref="M:log4net.ILog.Debug(System.Object)"/>
- <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
- </member>
- <member name="M:log4net.Util.ILogExtensions.DebugExt(log4net.ILog,System.Func{System.Object},System.Exception)">
- <summary>
- Log a message object with the <see cref="F:log4net.Core.Level.Debug"/> level including
- the stack trace of the <see cref="T:System.Exception"/> passed
- as a parameter.
- </summary>
- <param name="logger">The logger on which the message is logged.</param>
- <param name="callback">The lambda expression that gets the object to log.</param>
- <param name="exception">The exception to log, including its stack trace.</param>
- <remarks>
- <para>
- See the <see cref="M:log4net.Util.ILogExtensions.DebugExt(log4net.ILog,System.Object)"/> form for more detailed information.
- </para>
- </remarks>
- <seealso cref="M:log4net.ILog.Debug(System.Object)"/>
- <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
- </member>
- <member name="M:log4net.Util.ILogExtensions.DebugExt(log4net.ILog,System.Object)">
- <overloads>Log a message object with the <see cref="F:log4net.Core.Level.Debug"/> level.</overloads> //TODO
- <summary>
- Log a message object with the <see cref="F:log4net.Core.Level.Debug"/> level.
- </summary>
- <param name="logger">The logger on which the message is logged.</param>
- <param name="message">The message object to log.</param>
- <remarks>
- <para>
- This method first checks if this logger is <c>INFO</c>
- enabled by reading the value <seealso cref="P:log4net.ILog.IsDebugEnabled"/> property.
- This check happens always and does not depend on the <seealso cref="T:log4net.ILog"/>
- implementation. If this logger is <c>INFO</c> enabled, then it converts
- the message object (passed as parameter) to a string by invoking the appropriate
- <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then
- proceeds to call all the registered appenders in this logger
- and also higher in the hierarchy depending on the value of
- the additivity flag.
- </para>
- <para><b>WARNING</b> Note that passing an <see cref="T:System.Exception"/>
- to this method will print the name of the <see cref="T:System.Exception"/>
- but no stack trace. To print a stack trace use the
- <see cref="M:log4net.Util.ILogExtensions.DebugExt(log4net.ILog,System.Object,System.Exception)"/> form instead.
- </para>
- </remarks>
- <seealso cref="M:log4net.ILog.Debug(System.Object)"/>
- <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
- </member>
- <member name="M:log4net.Util.ILogExtensions.DebugExt(log4net.ILog,System.Object,System.Exception)">
- <summary>
- Log a message object with the <see cref="F:log4net.Core.Level.Debug"/> level including
- the stack trace of the <see cref="T:System.Exception"/> passed
- as a parameter.
- </summary>
- <param name="logger">The logger on which the message is logged.</param>
- <param name="message">The message object to log.</param>
- <param name="exception">The exception to log, including its stack trace.</param>
- <remarks>
- <para>
- See the <see cref="M:log4net.Util.ILogExtensions.DebugExt(log4net.ILog,System.Object)"/> form for more detailed information.
- </para>
- </remarks>
- <seealso cref="M:log4net.ILog.Debug(System.Object)"/>
- <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
- </member>
- <member name="M:log4net.Util.ILogExtensions.DebugFormatExt(log4net.ILog,System.String,System.Object)">
- <summary>
- Logs a formatted message string with the <see cref="F:log4net.Core.Level.Debug"/> level.
- </summary>
- <param name="logger">The logger on which the message is logged.</param>
- <param name="format">A String containing zero or more format items</param>
- <param name="arg0">An Object to format</param>
- <remarks>
- <para>
- The message is formatted using the <c>String.Format</c> method. See
- <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
- of the formatting.
- </para>
- <para>
- This method does not take an <see cref="T:System.Exception"/> object to include in the
- log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.Util.ILogExtensions.DebugExt(log4net.ILog,System.Object,System.Exception)"/>
- methods instead.
- </para>
- </remarks>
- <seealso cref="M:log4net.ILog.Debug(System.Object)"/>
- <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
- </member>
- <member name="M:log4net.Util.ILogExtensions.DebugFormatExt(log4net.ILog,System.String,System.Object[])">
- <summary>
- Logs a formatted message string with the <see cref="F:log4net.Core.Level.Debug"/> level.
- </summary>
- <param name="logger">The logger on which the message is logged.</param>
- <param name="format">A String containing zero or more format items</param>
- <param name="args">An Object array containing zero or more objects to format</param>
- <remarks>
- <para>
- The message is formatted using the <c>String.Format</c> method. See
- <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
- of the formatting.
- </para>
- <para>
- This method does not take an <see cref="T:System.Exception"/> object to include in the
- log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.Util.ILogExtensions.DebugExt(log4net.ILog,System.Object,System.Exception)"/>
- methods instead.
- </para>
- </remarks>
- <seealso cref="M:log4net.ILog.Debug(System.Object)"/>
- <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
- </member>
- <member name="M:log4net.Util.ILogExtensions.DebugFormatExt(log4net.ILog,System.IFormatProvider,System.String,System.Object[])">
- <summary>
- Logs a formatted message string with the <see cref="F:log4net.Core.Level.Debug"/> level.
- </summary>
- <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param>
- <param name="logger">The logger on which the message is logged.</param>
- <param name="format">A String containing zero or more format items</param>
- <param name="args">An Object array containing zero or more objects to format</param>
- <remarks>
- <para>
- The message is formatted using the <c>String.Format</c> method. See
- <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
- of the formatting.
- </para>
- <para>
- This method does not take an <see cref="T:System.Exception"/> object to include in the
- log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.Util.ILogExtensions.DebugExt(log4net.ILog,System.Object,System.Exception)"/>
- methods instead.
- </para>
- </remarks>
- <seealso cref="M:log4net.ILog.Debug(System.Object)"/>
- <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
- </member>
- <member name="M:log4net.Util.ILogExtensions.DebugFormatExt(log4net.ILog,System.String,System.Object,System.Object)">
- <summary>
- Logs a formatted message string with the <see cref="F:log4net.Core.Level.Debug"/> level.
- </summary>
- <param name="logger">The logger on which the message is logged.</param>
- <param name="format">A String containing zero or more format items</param>
- <param name="arg0">An Object to format</param>
- <param name="arg1">An Object to format</param>
- <remarks>
- <para>
- The message is formatted using the <c>String.Format</c> method. See
- <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
- of the formatting.
- </para>
- <para>
- This method does not take an <see cref="T:System.Exception"/> object to include in the
- log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.Util.ILogExtensions.DebugExt(log4net.ILog,System.Object,System.Exception)"/>
- methods instead.
- </para>
- </remarks>
- <seealso cref="M:log4net.ILog.Debug(System.Object)"/>
- <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
- </member>
- <member name="M:log4net.Util.ILogExtensions.DebugFormatExt(log4net.ILog,System.String,System.Object,System.Object,System.Object)">
- <summary>
- Logs a formatted message string with the <see cref="F:log4net.Core.Level.Debug"/> level.
- </summary>
- <param name="logger">The logger on which the message is logged.</param>
- <param name="format">A String containing zero or more format items</param>
- <param name="arg0">An Object to format</param>
- <param name="arg1">An Object to format</param>
- <param name="arg2">An Object to format</param>
- <remarks>
- <para>
- The message is formatted using the <c>String.Format</c> method. See
- <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
- of the formatting.
- </para>
- <para>
- This method does not take an <see cref="T:System.Exception"/> object to include in the
- log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.Util.ILogExtensions.DebugExt(log4net.ILog,System.Object,System.Exception)"/>
- methods instead.
- </para>
- </remarks>
- <seealso cref="M:log4net.ILog.Debug(System.Object)"/>
- <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
- </member>
- <member name="M:log4net.Util.ILogExtensions.InfoExt(log4net.ILog,System.Func{System.Object})">
- <summary>
- Log a message object with the <see cref="F:log4net.Core.Level.Info"/> level.
- </summary>
- <param name="logger">The logger on which the message is logged.</param>
- <param name="callback">The lambda expression that gets the object to log.</param>
- <remarks>
- <para>
- This method first checks if this logger is <c>INFO</c>
- enabled by reading the value <seealso cref="P:log4net.ILog.IsInfoEnabled"/> property.
- This check happens always and does not depend on the <seealso cref="T:log4net.ILog"/>
- implementation. If this logger is <c>INFO</c> enabled, then it converts
- the message object (retrieved by invocation of the provided callback) to a
- string by invoking the appropriate <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>.
- It then proceeds to call all the registered appenders in this logger
- and also higher in the hierarchy depending on the value of
- the additivity flag.
- </para>
- <para><b>WARNING</b> Note that passing an <see cref="T:System.Exception"/>
- to this method will print the name of the <see cref="T:System.Exception"/>
- but no stack trace. To print a stack trace use the
- <see cref="M:log4net.Util.ILogExtensions.InfoExt(log4net.ILog,System.Func{System.Object},System.Exception)"/> form instead.
- </para>
- </remarks>
- <seealso cref="M:log4net.ILog.Info(System.Object)"/>
- <seealso cref="P:log4net.ILog.IsInfoEnabled"/>
- </member>
- <member name="M:log4net.Util.ILogExtensions.InfoExt(log4net.ILog,System.Func{System.Object},System.Exception)">
- <summary>
- Log a message object with the <see cref="F:log4net.Core.Level.Info"/> level including
- the stack trace of the <see cref="T:System.Exception"/> passed
- as a parameter.
- </summary>
- <param name="logger">The logger on which the message is logged.</param>
- <param name="callback">The lambda expression that gets the object to log.</param>
- <param name="exception">The exception to log, including its stack trace.</param>
- <remarks>
- <para>
- See the <see cref="M:log4net.Util.ILogExtensions.InfoExt(log4net.ILog,System.Object)"/> form for more detailed information.
- </para>
- </remarks>
- <seealso cref="M:log4net.ILog.Info(System.Object)"/>
- <seealso cref="P:log4net.ILog.IsInfoEnabled"/>
- </member>
- <member name="M:log4net.Util.ILogExtensions.InfoExt(log4net.ILog,System.Object)">
- <overloads>Log a message object with the <see cref="F:log4net.Core.Level.Info"/> level.</overloads> //TODO
- <summary>
- Log a message object with the <see cref="F:log4net.Core.Level.Info"/> level.
- </summary>
- <param name="logger">The logger on which the message is logged.</param>
- <param name="message">The message object to log.</param>
- <remarks>
- <para>
- This method first checks if this logger is <c>INFO</c>
- enabled by reading the value <seealso cref="P:log4net.ILog.IsInfoEnabled"/> property.
- This check happens always and does not depend on the <seealso cref="T:log4net.ILog"/>
- implementation. If this logger is <c>INFO</c> enabled, then it converts
- the message object (passed as parameter) to a string by invoking the appropriate
- <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then
- proceeds to call all the registered appenders in this logger
- and also higher in the hierarchy depending on the value of
- the additivity flag.
- </para>
- <para><b>WARNING</b> Note that passing an <see cref="T:System.Exception"/>
- to this method will print the name of the <see cref="T:System.Exception"/>
- but no stack trace. To print a stack trace use the
- <see cref="M:log4net.Util.ILogExtensions.InfoExt(log4net.ILog,System.Object,System.Exception)"/> form instead.
- </para>
- </remarks>
- <seealso cref="M:log4net.ILog.Info(System.Object)"/>
- <seealso cref="P:log4net.ILog.IsInfoEnabled"/>
- </member>
- <member name="M:log4net.Util.ILogExtensions.InfoExt(log4net.ILog,System.Object,System.Exception)">
- <summary>
- Log a message object with the <see cref="F:log4net.Core.Level.Info"/> level including
- the stack trace of the <see cref="T:System.Exception"/> passed
- as a parameter.
- </summary>
- <param name="logger">The logger on which the message is logged.</param>
- <param name="message">The message object to log.</param>
- <param name="exception">The exception to log, including its stack trace.</param>
- <remarks>
- <para>
- See the <see cref="M:log4net.Util.ILogExtensions.InfoExt(log4net.ILog,System.Object)"/> form for more detailed information.
- </para>
- </remarks>
- <seealso cref="M:log4net.ILog.Info(System.Object)"/>
- <seealso cref="P:log4net.ILog.IsInfoEnabled"/>
- </member>
- <member name="M:log4net.Util.ILogExtensions.InfoFormatExt(log4net.ILog,System.String,System.Object)">
- <summary>
- Logs a formatted message string with the <see cref="F:log4net.Core.Level.Info"/> level.
- </summary>
- <param name="logger">The logger on which the message is logged.</param>
- <param name="format">A String containing zero or more format items</param>
- <param name="arg0">An Object to format</param>
- <remarks>
- <para>
- The message is formatted using the <c>String.Format</c> method. See
- <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
- of the formatting.
- </para>
- <para>
- This method does not take an <see cref="T:System.Exception"/> object to include in the
- log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.Util.ILogExtensions.InfoExt(log4net.ILog,System.Object,System.Exception)"/>
- methods instead.
- </para>
- </remarks>
- <seealso cref="M:log4net.ILog.Info(System.Object)"/>
- <seealso cref="P:log4net.ILog.IsInfoEnabled"/>
- </member>
- <member name="M:log4net.Util.ILogExtensions.InfoFormatExt(log4net.ILog,System.String,System.Object[])">
- <summary>
- Logs a formatted message string with the <see cref="F:log4net.Core.Level.Info"/> level.
- </summary>
- <param name="logger">The logger on which the message is logged.</param>
- <param name="format">A String containing zero or more format items</param>
- <param name="args">An Object array containing zero or more objects to format</param>
- <remarks>
- <para>
- The message is formatted using the <c>String.Format</c> method. See
- <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
- of the formatting.
- </para>
- <para>
- This method does not take an <see cref="T:System.Exception"/> object to include in the
- log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.Util.ILogExtensions.InfoExt(log4net.ILog,System.Object,System.Exception)"/>
- methods instead.
- </para>
- </remarks>
- <seealso cref="M:log4net.ILog.Info(System.Object)"/>
- <seealso cref="P:log4net.ILog.IsInfoEnabled"/>
- </member>
- <member name="M:log4net.Util.ILogExtensions.InfoFormatExt(log4net.ILog,System.IFormatProvider,System.String,System.Object[])">
- <summary>
- Logs a formatted message string with the <see cref="F:log4net.Core.Level.Info"/> level.
- </summary>
- <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param>
- <param name="logger">The logger on which the message is logged.</param>
- <param name="format">A String containing zero or more format items</param>
- <param name="args">An Object array containing zero or more objects to format</param>
- <remarks>
- <para>
- The message is formatted using the <c>String.Format</c> method. See
- <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
- of the formatting.
- </para>
- <para>
- This method does not take an <see cref="T:System.Exception"/> object to include in the
- log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.Util.ILogExtensions.InfoExt(log4net.ILog,System.Object,System.Exception)"/>
- methods instead.
- </para>
- </remarks>
- <seealso cref="M:log4net.ILog.Info(System.Object)"/>
- <seealso cref="P:log4net.ILog.IsInfoEnabled"/>
- </member>
- <member name="M:log4net.Util.ILogExtensions.InfoFormatExt(log4net.ILog,System.String,System.Object,System.Object)">
- <summary>
- Logs a formatted message string with the <see cref="F:log4net.Core.Level.Info"/> level.
- </summary>
- <param name="logger">The logger on which the message is logged.</param>
- <param name="format">A String containing zero or more format items</param>
- <param name="arg0">An Object to format</param>
- <param name="arg1">An Object to format</param>
- <remarks>
- <para>
- The message is formatted using the <c>String.Format</c> method. See
- <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
- of the formatting.
- </para>
- <para>
- This method does not take an <see cref="T:System.Exception"/> object to include in the
- log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.Util.ILogExtensions.InfoExt(log4net.ILog,System.Object,System.Exception)"/>
- methods instead.
- </para>
- </remarks>
- <seealso cref="M:log4net.ILog.Info(System.Object)"/>
- <seealso cref="P:log4net.ILog.IsInfoEnabled"/>
- </member>
- <member name="M:log4net.Util.ILogExtensions.InfoFormatExt(log4net.ILog,System.String,System.Object,System.Object,System.Object)">
- <summary>
- Logs a formatted message string with the <see cref="F:log4net.Core.Level.Info"/> level.
- </summary>
- <param name="logger">The logger on which the message is logged.</param>
- <param name="format">A String containing zero or more format items</param>
- <param name="arg0">An Object to format</param>
- <param name="arg1">An Object to format</param>
- <param name="arg2">An Object to format</param>
- <remarks>
- <para>
- The message is formatted using the <c>String.Format</c> method. See
- <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
- of the formatting.
- </para>
- <para>
- This method does not take an <see cref="T:System.Exception"/> object to include in the
- log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.Util.ILogExtensions.InfoExt(log4net.ILog,System.Object,System.Exception)"/>
- methods instead.
- </para>
- </remarks>
- <seealso cref="M:log4net.ILog.Info(System.Object)"/>
- <seealso cref="P:log4net.ILog.IsInfoEnabled"/>
- </member>
- <member name="M:log4net.Util.ILogExtensions.WarnExt(log4net.ILog,System.Func{System.Object})">
- <summary>
- Log a message object with the <see cref="F:log4net.Core.Level.Warn"/> level.
- </summary>
- <param name="logger">The logger on which the message is logged.</param>
- <param name="callback">The lambda expression that gets the object to log.</param>
- <remarks>
- <para>
- This method first checks if this logger is <c>WARN</c>
- enabled by reading the value <seealso cref="P:log4net.ILog.IsWarnEnabled"/> property.
- This check happens always and does not depend on the <seealso cref="T:log4net.ILog"/>
- implementation. If this logger is <c>WARN</c> enabled, then it converts
- the message object (retrieved by invocation of the provided callback) to a
- string by invoking the appropriate <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>.
- It then proceeds to call all the registered appenders in this logger
- and also higher in the hierarchy depending on the value of
- the additivity flag.
- </para>
- <para><b>WARNING</b> Note that passing an <see cref="T:System.Exception"/>
- to this method will print the name of the <see cref="T:System.Exception"/>
- but no stack trace. To print a stack trace use the
- <see cref="M:log4net.Util.ILogExtensions.WarnExt(log4net.ILog,System.Func{System.Object},System.Exception)"/> form instead.
- </para>
- </remarks>
- <seealso cref="M:log4net.ILog.Warn(System.Object)"/>
- <seealso cref="P:log4net.ILog.IsWarnEnabled"/>
- </member>
- <member name="M:log4net.Util.ILogExtensions.WarnExt(log4net.ILog,System.Func{System.Object},System.Exception)">
- <summary>
- Log a message object with the <see cref="F:log4net.Core.Level.Warn"/> level including
- the stack trace of the <see cref="T:System.Exception"/> passed
- as a parameter.
- </summary>
- <param name="logger">The logger on which the message is logged.</param>
- <param name="callback">The lambda expression that gets the object to log.</param>
- <param name="exception">The exception to log, including its stack trace.</param>
- <remarks>
- <para>
- See the <see cref="M:log4net.Util.ILogExtensions.WarnExt(log4net.ILog,System.Object)"/> form for more detailed information.
- </para>
- </remarks>
- <seealso cref="M:log4net.ILog.Warn(System.Object)"/>
- <seealso cref="P:log4net.ILog.IsWarnEnabled"/>
- </member>
- <member name="M:log4net.Util.ILogExtensions.WarnExt(log4net.ILog,System.Object)">
- <overloads>Log a message object with the <see cref="F:log4net.Core.Level.Warn"/> level.</overloads> //TODO
- <summary>
- Log a message object with the <see cref="F:log4net.Core.Level.Warn"/> level.
- </summary>
- <param name="logger">The logger on which the message is logged.</param>
- <param name="message">The message object to log.</param>
- <remarks>
- <para>
- This method first checks if this logger is <c>WARN</c>
- enabled by reading the value <seealso cref="P:log4net.ILog.IsWarnEnabled"/> property.
- This check happens always and does not depend on the <seealso cref="T:log4net.ILog"/>
- implementation. If this logger is <c>WARN</c> enabled, then it converts
- the message object (passed as parameter) to a string by invoking the appropriate
- <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then
- proceeds to call all the registered appenders in this logger
- and also higher in the hierarchy depending on the value of
- the additivity flag.
- </para>
- <para><b>WARNING</b> Note that passing an <see cref="T:System.Exception"/>
- to this method will print the name of the <see cref="T:System.Exception"/>
- but no stack trace. To print a stack trace use the
- <see cref="M:log4net.Util.ILogExtensions.WarnExt(log4net.ILog,System.Object,System.Exception)"/> form instead.
- </para>
- </remarks>
- <seealso cref="M:log4net.ILog.Warn(System.Object)"/>
- <seealso cref="P:log4net.ILog.IsWarnEnabled"/>
- </member>
- <member name="M:log4net.Util.ILogExtensions.WarnExt(log4net.ILog,System.Object,System.Exception)">
- <summary>
- Log a message object with the <see cref="F:log4net.Core.Level.Warn"/> level including
- the stack trace of the <see cref="T:System.Exception"/> passed
- as a parameter.
- </summary>
- <param name="logger">The logger on which the message is logged.</param>
- <param name="message">The message object to log.</param>
- <param name="exception">The exception to log, including its stack trace.</param>
- <remarks>
- <para>
- See the <see cref="M:log4net.Util.ILogExtensions.WarnExt(log4net.ILog,System.Object)"/> form for more detailed information.
- </para>
- </remarks>
- <seealso cref="M:log4net.ILog.Warn(System.Object)"/>
- <seealso cref="P:log4net.ILog.IsWarnEnabled"/>
- </member>
- <member name="M:log4net.Util.ILogExtensions.WarnFormatExt(log4net.ILog,System.String,System.Object)">
- <summary>
- Logs a formatted message string with the <see cref="F:log4net.Core.Level.Warn"/> level.
- </summary>
- <param name="logger">The logger on which the message is logged.</param>
- <param name="format">A String containing zero or more format items</param>
- <param name="arg0">An Object to format</param>
- <remarks>
- <para>
- The message is formatted using the <c>String.Format</c> method. See
- <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
- of the formatting.
- </para>
- <para>
- This method does not take an <see cref="T:System.Exception"/> object to include in the
- log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.Util.ILogExtensions.WarnExt(log4net.ILog,System.Object,System.Exception)"/>
- methods instead.
- </para>
- </remarks>
- <seealso cref="M:log4net.ILog.Warn(System.Object)"/>
- <seealso cref="P:log4net.ILog.IsWarnEnabled"/>
- </member>
- <member name="M:log4net.Util.ILogExtensions.WarnFormatExt(log4net.ILog,System.String,System.Object[])">
- <summary>
- Logs a formatted message string with the <see cref="F:log4net.Core.Level.Warn"/> level.
- </summary>
- <param name="logger">The logger on which the message is logged.</param>
- <param name="format">A String containing zero or more format items</param>
- <param name="args">An Object array containing zero or more objects to format</param>
- <remarks>
- <para>
- The message is formatted using the <c>String.Format</c> method. See
- <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
- of the formatting.
- </para>
- <para>
- This method does not take an <see cref="T:System.Exception"/> object to include in the
- log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.Util.ILogExtensions.WarnExt(log4net.ILog,System.Object,System.Exception)"/>
- methods instead.
- </para>
- </remarks>
- <seealso cref="M:log4net.ILog.Warn(System.Object)"/>
- <seealso cref="P:log4net.ILog.IsWarnEnabled"/>
- </member>
- <member name="M:log4net.Util.ILogExtensions.WarnFormatExt(log4net.ILog,System.IFormatProvider,System.String,System.Object[])">
- <summary>
- Logs a formatted message string with the <see cref="F:log4net.Core.Level.Warn"/> level.
- </summary>
- <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param>
- <param name="logger">The logger on which the message is logged.</param>
- <param name="format">A String containing zero or more format items</param>
- <param name="args">An Object array containing zero or more objects to format</param>
- <remarks>
- <para>
- The message is formatted using the <c>String.Format</c> method. See
- <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
- of the formatting.
- </para>
- <para>
- This method does not take an <see cref="T:System.Exception"/> object to include in the
- log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.Util.ILogExtensions.WarnExt(log4net.ILog,System.Object,System.Exception)"/>
- methods instead.
- </para>
- </remarks>
- <seealso cref="M:log4net.ILog.Warn(System.Object)"/>
- <seealso cref="P:log4net.ILog.IsWarnEnabled"/>
- </member>
- <member name="M:log4net.Util.ILogExtensions.WarnFormatExt(log4net.ILog,System.String,System.Object,System.Object)">
- <summary>
- Logs a formatted message string with the <see cref="F:log4net.Core.Level.Warn"/> level.
- </summary>
- <param name="logger">The logger on which the message is logged.</param>
- <param name="format">A String containing zero or more format items</param>
- <param name="arg0">An Object to format</param>
- <param name="arg1">An Object to format</param>
- <remarks>
- <para>
- The message is formatted using the <c>String.Format</c> method. See
- <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
- of the formatting.
- </para>
- <para>
- This method does not take an <see cref="T:System.Exception"/> object to include in the
- log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.Util.ILogExtensions.WarnExt(log4net.ILog,System.Object,System.Exception)"/>
- methods instead.
- </para>
- </remarks>
- <seealso cref="M:log4net.ILog.Warn(System.Object)"/>
- <seealso cref="P:log4net.ILog.IsWarnEnabled"/>
- </member>
- <member name="M:log4net.Util.ILogExtensions.WarnFormatExt(log4net.ILog,System.String,System.Object,System.Object,System.Object)">
- <summary>
- Logs a formatted message string with the <see cref="F:log4net.Core.Level.Warn"/> level.
- </summary>
- <param name="logger">The logger on which the message is logged.</param>
- <param name="format">A String containing zero or more format items</param>
- <param name="arg0">An Object to format</param>
- <param name="arg1">An Object to format</param>
- <param name="arg2">An Object to format</param>
- <remarks>
- <para>
- The message is formatted using the <c>String.Format</c> method. See
- <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
- of the formatting.
- </para>
- <para>
- This method does not take an <see cref="T:System.Exception"/> object to include in the
- log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.Util.ILogExtensions.WarnExt(log4net.ILog,System.Object,System.Exception)"/>
- methods instead.
- </para>
- </remarks>
- <seealso cref="M:log4net.ILog.Warn(System.Object)"/>
- <seealso cref="P:log4net.ILog.IsWarnEnabled"/>
- </member>
- <member name="M:log4net.Util.ILogExtensions.ErrorExt(log4net.ILog,System.Func{System.Object})">
- <summary>
- Log a message object with the <see cref="F:log4net.Core.Level.Error"/> level.
- </summary>
- <param name="logger">The logger on which the message is logged.</param>
- <param name="callback">The lambda expression that gets the object to log.</param>
- <remarks>
- <para>
- This method first checks if this logger is <c>ERROR</c>
- enabled by reading the value <seealso cref="P:log4net.ILog.IsErrorEnabled"/> property.
- This check happens always and does not depend on the <seealso cref="T:log4net.ILog"/>
- implementation. If this logger is <c>ERROR</c> enabled, then it converts
- the message object (retrieved by invocation of the provided callback) to a
- string by invoking the appropriate <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>.
- It then proceeds to call all the registered appenders in this logger
- and also higher in the hierarchy depending on the value of
- the additivity flag.
- </para>
- <para><b>WARNING</b> Note that passing an <see cref="T:System.Exception"/>
- to this method will print the name of the <see cref="T:System.Exception"/>
- but no stack trace. To print a stack trace use the
- <see cref="M:log4net.Util.ILogExtensions.ErrorExt(log4net.ILog,System.Func{System.Object},System.Exception)"/> form instead.
- </para>
- </remarks>
- <seealso cref="M:log4net.ILog.Error(System.Object)"/>
- <seealso cref="P:log4net.ILog.IsErrorEnabled"/>
- </member>
- <member name="M:log4net.Util.ILogExtensions.ErrorExt(log4net.ILog,System.Func{System.Object},System.Exception)">
- <summary>
- Log a message object with the <see cref="F:log4net.Core.Level.Error"/> level including
- the stack trace of the <see cref="T:System.Exception"/> passed
- as a parameter.
- </summary>
- <param name="logger">The logger on which the message is logged.</param>
- <param name="callback">The lambda expression that gets the object to log.</param>
- <param name="exception">The exception to log, including its stack trace.</param>
- <remarks>
- <para>
- See the <see cref="M:log4net.Util.ILogExtensions.ErrorExt(log4net.ILog,System.Object)"/> form for more detailed information.
- </para>
- </remarks>
- <seealso cref="M:log4net.ILog.Error(System.Object)"/>
- <seealso cref="P:log4net.ILog.IsErrorEnabled"/>
- </member>
- <member name="M:log4net.Util.ILogExtensions.ErrorExt(log4net.ILog,System.Object)">
- <overloads>Log a message object with the <see cref="F:log4net.Core.Level.Error"/> level.</overloads> //TODO
- <summary>
- Log a message object with the <see cref="F:log4net.Core.Level.Error"/> level.
- </summary>
- <param name="logger">The logger on which the message is logged.</param>
- <param name="message">The message object to log.</param>
- <remarks>
- <para>
- This method first checks if this logger is <c>ERROR</c>
- enabled by reading the value <seealso cref="P:log4net.ILog.IsErrorEnabled"/> property.
- This check happens always and does not depend on the <seealso cref="T:log4net.ILog"/>
- implementation. If this logger is <c>ERROR</c> enabled, then it converts
- the message object (passed as parameter) to a string by invoking the appropriate
- <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then
- proceeds to call all the registered appenders in this logger
- and also higher in the hierarchy depending on the value of
- the additivity flag.
- </para>
- <para><b>WARNING</b> Note that passing an <see cref="T:System.Exception"/>
- to this method will print the name of the <see cref="T:System.Exception"/>
- but no stack trace. To print a stack trace use the
- <see cref="M:log4net.Util.ILogExtensions.ErrorExt(log4net.ILog,System.Object,System.Exception)"/> form instead.
- </para>
- </remarks>
- <seealso cref="M:log4net.ILog.Error(System.Object)"/>
- <seealso cref="P:log4net.ILog.IsErrorEnabled"/>
- </member>
- <member name="M:log4net.Util.ILogExtensions.ErrorExt(log4net.ILog,System.Object,System.Exception)">
- <summary>
- Log a message object with the <see cref="F:log4net.Core.Level.Error"/> level including
- the stack trace of the <see cref="T:System.Exception"/> passed
- as a parameter.
- </summary>
- <param name="logger">The logger on which the message is logged.</param>
- <param name="message">The message object to log.</param>
- <param name="exception">The exception to log, including its stack trace.</param>
- <remarks>
- <para>
- See the <see cref="M:log4net.Util.ILogExtensions.ErrorExt(log4net.ILog,System.Object)"/> form for more detailed information.
- </para>
- </remarks>
- <seealso cref="M:log4net.ILog.Error(System.Object)"/>
- <seealso cref="P:log4net.ILog.IsErrorEnabled"/>
- </member>
- <member name="M:log4net.Util.ILogExtensions.ErrorFormatExt(log4net.ILog,System.String,System.Object)">
- <summary>
- Logs a formatted message string with the <see cref="F:log4net.Core.Level.Error"/> level.
- </summary>
- <param name="logger">The logger on which the message is logged.</param>
- <param name="format">A String containing zero or more format items</param>
- <param name="arg0">An Object to format</param>
- <remarks>
- <para>
- The message is formatted using the <c>String.Format</c> method. See
- <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
- of the formatting.
- </para>
- <para>
- This method does not take an <see cref="T:System.Exception"/> object to include in the
- log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.Util.ILogExtensions.ErrorExt(log4net.ILog,System.Object,System.Exception)"/>
- methods instead.
- </para>
- </remarks>
- <seealso cref="M:log4net.ILog.Error(System.Object)"/>
- <seealso cref="P:log4net.ILog.IsErrorEnabled"/>
- </member>
- <member name="M:log4net.Util.ILogExtensions.ErrorFormatExt(log4net.ILog,System.String,System.Object[])">
- <summary>
- Logs a formatted message string with the <see cref="F:log4net.Core.Level.Error"/> level.
- </summary>
- <param name="logger">The logger on which the message is logged.</param>
- <param name="format">A String containing zero or more format items</param>
- <param name="args">An Object array containing zero or more objects to format</param>
- <remarks>
- <para>
- The message is formatted using the <c>String.Format</c> method. See
- <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
- of the formatting.
- </para>
- <para>
- This method does not take an <see cref="T:System.Exception"/> object to include in the
- log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.Util.ILogExtensions.ErrorExt(log4net.ILog,System.Object,System.Exception)"/>
- methods instead.
- </para>
- </remarks>
- <seealso cref="M:log4net.ILog.Error(System.Object)"/>
- <seealso cref="P:log4net.ILog.IsErrorEnabled"/>
- </member>
- <member name="M:log4net.Util.ILogExtensions.ErrorFormatExt(log4net.ILog,System.IFormatProvider,System.String,System.Object[])">
- <summary>
- Logs a formatted message string with the <see cref="F:log4net.Core.Level.Error"/> level.
- </summary>
- <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param>
- <param name="logger">The logger on which the message is logged.</param>
- <param name="format">A String containing zero or more format items</param>
- <param name="args">An Object array containing zero or more objects to format</param>
- <remarks>
- <para>
- The message is formatted using the <c>String.Format</c> method. See
- <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
- of the formatting.
- </para>
- <para>
- This method does not take an <see cref="T:System.Exception"/> object to include in the
- log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.Util.ILogExtensions.ErrorExt(log4net.ILog,System.Object,System.Exception)"/>
- methods instead.
- </para>
- </remarks>
- <seealso cref="M:log4net.ILog.Error(System.Object)"/>
- <seealso cref="P:log4net.ILog.IsErrorEnabled"/>
- </member>
- <member name="M:log4net.Util.ILogExtensions.ErrorFormatExt(log4net.ILog,System.String,System.Object,System.Object)">
- <summary>
- Logs a formatted message string with the <see cref="F:log4net.Core.Level.Error"/> level.
- </summary>
- <param name="logger">The logger on which the message is logged.</param>
- <param name="format">A String containing zero or more format items</param>
- <param name="arg0">An Object to format</param>
- <param name="arg1">An Object to format</param>
- <remarks>
- <para>
- The message is formatted using the <c>String.Format</c> method. See
- <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
- of the formatting.
- </para>
- <para>
- This method does not take an <see cref="T:System.Exception"/> object to include in the
- log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.Util.ILogExtensions.ErrorExt(log4net.ILog,System.Object,System.Exception)"/>
- methods instead.
- </para>
- </remarks>
- <seealso cref="M:log4net.ILog.Error(System.Object)"/>
- <seealso cref="P:log4net.ILog.IsErrorEnabled"/>
- </member>
- <member name="M:log4net.Util.ILogExtensions.ErrorFormatExt(log4net.ILog,System.String,System.Object,System.Object,System.Object)">
- <summary>
- Logs a formatted message string with the <see cref="F:log4net.Core.Level.Error"/> level.
- </summary>
- <param name="logger">The logger on which the message is logged.</param>
- <param name="format">A String containing zero or more format items</param>
- <param name="arg0">An Object to format</param>
- <param name="arg1">An Object to format</param>
- <param name="arg2">An Object to format</param>
- <remarks>
- <para>
- The message is formatted using the <c>String.Format</c> method. See
- <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
- of the formatting.
- </para>
- <para>
- This method does not take an <see cref="T:System.Exception"/> object to include in the
- log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.Util.ILogExtensions.ErrorExt(log4net.ILog,System.Object,System.Exception)"/>
- methods instead.
- </para>
- </remarks>
- <seealso cref="M:log4net.ILog.Error(System.Object)"/>
- <seealso cref="P:log4net.ILog.IsErrorEnabled"/>
- </member>
- <member name="M:log4net.Util.ILogExtensions.FatalExt(log4net.ILog,System.Func{System.Object})">
- <summary>
- Log a message object with the <see cref="F:log4net.Core.Level.Fatal"/> level.
- </summary>
- <param name="logger">The logger on which the message is logged.</param>
- <param name="callback">The lambda expression that gets the object to log.</param>
- <remarks>
- <para>
- This method first checks if this logger is <c>FATAL</c>
- enabled by reading the value <seealso cref="P:log4net.ILog.IsFatalEnabled"/> property.
- This check happens always and does not depend on the <seealso cref="T:log4net.ILog"/>
- implementation. If this logger is <c>FATAL</c> enabled, then it converts
- the message object (retrieved by invocation of the provided callback) to a
- string by invoking the appropriate <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>.
- It then proceeds to call all the registered appenders in this logger
- and also higher in the hierarchy depending on the value of
- the additivity flag.
- </para>
- <para><b>WARNING</b> Note that passing an <see cref="T:System.Exception"/>
- to this method will print the name of the <see cref="T:System.Exception"/>
- but no stack trace. To print a stack trace use the
- <see cref="M:log4net.Util.ILogExtensions.FatalExt(log4net.ILog,System.Func{System.Object},System.Exception)"/> form instead.
- </para>
- </remarks>
- <seealso cref="M:log4net.ILog.Fatal(System.Object)"/>
- <seealso cref="P:log4net.ILog.IsFatalEnabled"/>
- </member>
- <member name="M:log4net.Util.ILogExtensions.FatalExt(log4net.ILog,System.Func{System.Object},System.Exception)">
- <summary>
- Log a message object with the <see cref="F:log4net.Core.Level.Fatal"/> level including
- the stack trace of the <see cref="T:System.Exception"/> passed
- as a parameter.
- </summary>
- <param name="logger">The logger on which the message is logged.</param>
- <param name="callback">The lambda expression that gets the object to log.</param>
- <param name="exception">The exception to log, including its stack trace.</param>
- <remarks>
- <para>
- See the <see cref="M:log4net.Util.ILogExtensions.FatalExt(log4net.ILog,System.Object)"/> form for more detailed information.
- </para>
- </remarks>
- <seealso cref="M:log4net.ILog.Fatal(System.Object)"/>
- <seealso cref="P:log4net.ILog.IsFatalEnabled"/>
- </member>
- <member name="M:log4net.Util.ILogExtensions.FatalExt(log4net.ILog,System.Object)">
- <overloads>Log a message object with the <see cref="F:log4net.Core.Level.Fatal"/> level.</overloads> //TODO
- <summary>
- Log a message object with the <see cref="F:log4net.Core.Level.Fatal"/> level.
- </summary>
- <param name="logger">The logger on which the message is logged.</param>
- <param name="message">The message object to log.</param>
- <remarks>
- <para>
- This method first checks if this logger is <c>FATAL</c>
- enabled by reading the value <seealso cref="P:log4net.ILog.IsFatalEnabled"/> property.
- This check happens always and does not depend on the <seealso cref="T:log4net.ILog"/>
- implementation. If this logger is <c>FATAL</c> enabled, then it converts
- the message object (passed as parameter) to a string by invoking the appropriate
- <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then
- proceeds to call all the registered appenders in this logger
- and also higher in the hierarchy depending on the value of
- the additivity flag.
- </para>
- <para><b>WARNING</b> Note that passing an <see cref="T:System.Exception"/>
- to this method will print the name of the <see cref="T:System.Exception"/>
- but no stack trace. To print a stack trace use the
- <see cref="M:log4net.Util.ILogExtensions.FatalExt(log4net.ILog,System.Object,System.Exception)"/> form instead.
- </para>
- </remarks>
- <seealso cref="M:log4net.ILog.Fatal(System.Object)"/>
- <seealso cref="P:log4net.ILog.IsFatalEnabled"/>
- </member>
- <member name="M:log4net.Util.ILogExtensions.FatalExt(log4net.ILog,System.Object,System.Exception)">
- <summary>
- Log a message object with the <see cref="F:log4net.Core.Level.Fatal"/> level including
- the stack trace of the <see cref="T:System.Exception"/> passed
- as a parameter.
- </summary>
- <param name="logger">The logger on which the message is logged.</param>
- <param name="message">The message object to log.</param>
- <param name="exception">The exception to log, including its stack trace.</param>
- <remarks>
- <para>
- See the <see cref="M:log4net.Util.ILogExtensions.FatalExt(log4net.ILog,System.Object)"/> form for more detailed information.
- </para>
- </remarks>
- <seealso cref="M:log4net.ILog.Fatal(System.Object)"/>
- <seealso cref="P:log4net.ILog.IsFatalEnabled"/>
- </member>
- <member name="M:log4net.Util.ILogExtensions.FatalFormatExt(log4net.ILog,System.String,System.Object)">
- <summary>
- Logs a formatted message string with the <see cref="F:log4net.Core.Level.Fatal"/> level.
- </summary>
- <param name="logger">The logger on which the message is logged.</param>
- <param name="format">A String containing zero or more format items</param>
- <param name="arg0">An Object to format</param>
- <remarks>
- <para>
- The message is formatted using the <c>String.Format</c> method. See
- <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
- of the formatting.
- </para>
- <para>
- This method does not take an <see cref="T:System.Exception"/> object to include in the
- log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.Util.ILogExtensions.FatalExt(log4net.ILog,System.Object,System.Exception)"/>
- methods instead.
- </para>
- </remarks>
- <seealso cref="M:log4net.ILog.Fatal(System.Object)"/>
- <seealso cref="P:log4net.ILog.IsFatalEnabled"/>
- </member>
- <member name="M:log4net.Util.ILogExtensions.FatalFormatExt(log4net.ILog,System.String,System.Object[])">
- <summary>
- Logs a formatted message string with the <see cref="F:log4net.Core.Level.Fatal"/> level.
- </summary>
- <param name="logger">The logger on which the message is logged.</param>
- <param name="format">A String containing zero or more format items</param>
- <param name="args">An Object array containing zero or more objects to format</param>
- <remarks>
- <para>
- The message is formatted using the <c>String.Format</c> method. See
- <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
- of the formatting.
- </para>
- <para>
- This method does not take an <see cref="T:System.Exception"/> object to include in the
- log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.Util.ILogExtensions.FatalExt(log4net.ILog,System.Object,System.Exception)"/>
- methods instead.
- </para>
- </remarks>
- <seealso cref="M:log4net.ILog.Fatal(System.Object)"/>
- <seealso cref="P:log4net.ILog.IsFatalEnabled"/>
- </member>
- <member name="M:log4net.Util.ILogExtensions.FatalFormatExt(log4net.ILog,System.IFormatProvider,System.String,System.Object[])">
- <summary>
- Logs a formatted message string with the <see cref="F:log4net.Core.Level.Fatal"/> level.
- </summary>
- <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param>
- <param name="logger">The logger on which the message is logged.</param>
- <param name="format">A String containing zero or more format items</param>
- <param name="args">An Object array containing zero or more objects to format</param>
- <remarks>
- <para>
- The message is formatted using the <c>String.Format</c> method. See
- <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
- of the formatting.
- </para>
- <para>
- This method does not take an <see cref="T:System.Exception"/> object to include in the
- log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.Util.ILogExtensions.FatalExt(log4net.ILog,System.Object,System.Exception)"/>
- methods instead.
- </para>
- </remarks>
- <seealso cref="M:log4net.ILog.Fatal(System.Object)"/>
- <seealso cref="P:log4net.ILog.IsFatalEnabled"/>
- </member>
- <member name="M:log4net.Util.ILogExtensions.FatalFormatExt(log4net.ILog,System.String,System.Object,System.Object)">
- <summary>
- Logs a formatted message string with the <see cref="F:log4net.Core.Level.Fatal"/> level.
- </summary>
- <param name="logger">The logger on which the message is logged.</param>
- <param name="format">A String containing zero or more format items</param>
- <param name="arg0">An Object to format</param>
- <param name="arg1">An Object to format</param>
- <remarks>
- <para>
- The message is formatted using the <c>String.Format</c> method. See
- <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
- of the formatting.
- </para>
- <para>
- This method does not take an <see cref="T:System.Exception"/> object to include in the
- log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.Util.ILogExtensions.FatalExt(log4net.ILog,System.Object,System.Exception)"/>
- methods instead.
- </para>
- </remarks>
- <seealso cref="M:log4net.ILog.Fatal(System.Object)"/>
- <seealso cref="P:log4net.ILog.IsFatalEnabled"/>
- </member>
- <member name="M:log4net.Util.ILogExtensions.FatalFormatExt(log4net.ILog,System.String,System.Object,System.Object,System.Object)">
- <summary>
- Logs a formatted message string with the <see cref="F:log4net.Core.Level.Fatal"/> level.
- </summary>
- <param name="logger">The logger on which the message is logged.</param>
- <param name="format">A String containing zero or more format items</param>
- <param name="arg0">An Object to format</param>
- <param name="arg1">An Object to format</param>
- <param name="arg2">An Object to format</param>
- <remarks>
- <para>
- The message is formatted using the <c>String.Format</c> method. See
- <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
- of the formatting.
- </para>
- <para>
- This method does not take an <see cref="T:System.Exception"/> object to include in the
- log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.Util.ILogExtensions.FatalExt(log4net.ILog,System.Object,System.Exception)"/>
- methods instead.
- </para>
- </remarks>
- <seealso cref="M:log4net.ILog.Fatal(System.Object)"/>
- <seealso cref="P:log4net.ILog.IsFatalEnabled"/>
- </member>
- <member name="T:log4net.Util.LevelMapping">
- <summary>
- Manages a mapping from levels to <see cref="T:log4net.Util.LevelMappingEntry"/>
- </summary>
- <remarks>
- <para>
- Manages an ordered mapping from <see cref="T:log4net.Core.Level"/> instances
- to <see cref="T:log4net.Util.LevelMappingEntry"/> subclasses.
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- </member>
- <member name="M:log4net.Util.LevelMapping.#ctor">
- <summary>
- Default constructor
- </summary>
- <remarks>
- <para>
- Initialise a new instance of <see cref="T:log4net.Util.LevelMapping"/>.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.LevelMapping.Add(log4net.Util.LevelMappingEntry)">
- <summary>
- Add a <see cref="T:log4net.Util.LevelMappingEntry"/> to this mapping
- </summary>
- <param name="entry">the entry to add</param>
- <remarks>
- <para>
- If a <see cref="T:log4net.Util.LevelMappingEntry"/> has previously been added
- for the same <see cref="T:log4net.Core.Level"/> then that entry will be
- overwritten.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.LevelMapping.Lookup(log4net.Core.Level)">
- <summary>
- Lookup the mapping for the specified level
- </summary>
- <param name="level">the level to lookup</param>
- <returns>the <see cref="T:log4net.Util.LevelMappingEntry"/> for the level or <c>null</c> if no mapping found</returns>
- <remarks>
- <para>
- Lookup the value for the specified level. Finds the nearest
- mapping value for the level that is equal to or less than the
- <paramref name="level"/> specified.
- </para>
- <para>
- If no mapping could be found then <c>null</c> is returned.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.LevelMapping.ActivateOptions">
- <summary>
- Initialize options
- </summary>
- <remarks>
- <para>
- Caches the sorted list of <see cref="T:log4net.Util.LevelMappingEntry"/> in an array
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Util.LogicalThreadContextProperties">
- <summary>
- Implementation of Properties collection for the <see cref="T:log4net.LogicalThreadContext"/>
- </summary>
- <remarks>
- <para>
- Class implements a collection of properties that is specific to each thread.
- The class is not synchronized as each thread has its own <see cref="T:log4net.Util.PropertiesDictionary"/>.
- </para>
- <para>
- This class stores its properties in a slot on the <see cref="T:System.Runtime.Remoting.Messaging.CallContext"/> named
- <c>log4net.Util.LogicalThreadContextProperties</c>.
- </para>
- <para>
- The <see cref="T:System.Runtime.Remoting.Messaging.CallContext"/> requires a link time
- <see cref="T:System.Security.Permissions.SecurityPermission"/> for the
- <see cref="F:System.Security.Permissions.SecurityPermissionFlag.Infrastructure"/>.
- If the calling code does not have this permission then this context will be disabled.
- It will not store any property values set on it.
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- </member>
- <member name="F:log4net.Util.LogicalThreadContextProperties.m_disabled">
- <summary>
- Flag used to disable this context if we don't have permission to access the CallContext.
- </summary>
- </member>
- <member name="M:log4net.Util.LogicalThreadContextProperties.#ctor">
- <summary>
- Constructor
- </summary>
- <remarks>
- <para>
- Initializes a new instance of the <see cref="T:log4net.Util.LogicalThreadContextProperties"/> class.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.LogicalThreadContextProperties.Remove(System.String)">
- <summary>
- Remove a property
- </summary>
- <param name="key">the key for the entry to remove</param>
- <remarks>
- <para>
- Remove the value for the specified <paramref name="key"/> from the context.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.LogicalThreadContextProperties.Clear">
- <summary>
- Clear all the context properties
- </summary>
- <remarks>
- <para>
- Clear all the context properties
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.LogicalThreadContextProperties.GetProperties(System.Boolean)">
- <summary>
- Get the PropertiesDictionary stored in the LocalDataStoreSlot for this thread.
- </summary>
- <param name="create">create the dictionary if it does not exist, otherwise return null if is does not exist</param>
- <returns>the properties for this thread</returns>
- <remarks>
- <para>
- The collection returned is only to be used on the calling thread. If the
- caller needs to share the collection between different threads then the
- caller must clone the collection before doings so.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.LogicalThreadContextProperties.GetCallContextData">
- <summary>
- Gets the call context get data.
- </summary>
- <returns>The peroperties dictionary stored in the call context</returns>
- <remarks>
- The <see cref="T:System.Runtime.Remoting.Messaging.CallContext"/> method <see cref="M:System.Runtime.Remoting.Messaging.CallContext.GetData(System.String)"/> has a
- security link demand, therfore we must put the method call in a seperate method
- that we can wrap in an exception handler.
- </remarks>
- </member>
- <member name="M:log4net.Util.LogicalThreadContextProperties.SetCallContextData(log4net.Util.PropertiesDictionary)">
- <summary>
- Sets the call context data.
- </summary>
- <param name="properties">The properties.</param>
- <remarks>
- The <see cref="T:System.Runtime.Remoting.Messaging.CallContext"/> method <see cref="M:System.Runtime.Remoting.Messaging.CallContext.SetData(System.String,System.Object)"/> has a
- security link demand, therfore we must put the method call in a seperate method
- that we can wrap in an exception handler.
- </remarks>
- </member>
- <member name="F:log4net.Util.LogicalThreadContextProperties.declaringType">
- <summary>
- The fully qualified type of the LogicalThreadContextProperties class.
- </summary>
- <remarks>
- Used by the internal logger to record the Type of the
- log message.
- </remarks>
- </member>
- <member name="P:log4net.Util.LogicalThreadContextProperties.Item(System.String)">
- <summary>
- Gets or sets the value of a property
- </summary>
- <value>
- The value for the property with the specified key
- </value>
- <remarks>
- <para>
- Get or set the property value for the <paramref name="key"/> specified.
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Util.LogReceivedEventHandler">
- <summary>
-
- </summary>
- <param name="source"></param>
- <param name="e"></param>
- </member>
- <member name="T:log4net.Util.LogLog">
- <summary>
- Outputs log statements from within the log4net assembly.
- </summary>
- <remarks>
- <para>
- Log4net components cannot make log4net logging calls. However, it is
- sometimes useful for the user to learn about what log4net is
- doing.
- </para>
- <para>
- All log4net internal debug calls go to the standard output stream
- whereas internal error messages are sent to the standard error output
- stream.
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- <author>Gert Driesen</author>
- </member>
- <member name="M:log4net.Util.LogLog.ToString">
- <summary>
- Formats Prefix, Source, and Message in the same format as the value
- sent to Console.Out and Trace.Write.
- </summary>
- <returns></returns>
- </member>
- <member name="M:log4net.Util.LogLog.#ctor(System.Type,System.String,System.String,System.Exception)">
- <summary>
- Initializes a new instance of the <see cref="T:log4net.Util.LogLog"/> class.
- </summary>
- <param name="source"></param>
- <param name="prefix"></param>
- <param name="message"></param>
- <param name="exception"></param>
- </member>
- <member name="M:log4net.Util.LogLog.#cctor">
- <summary>
- Static constructor that initializes logging by reading
- settings from the application configuration file.
- </summary>
- <remarks>
- <para>
- The <c>log4net.Internal.Debug</c> application setting
- controls internal debugging. This setting should be set
- to <c>true</c> to enable debugging.
- </para>
- <para>
- The <c>log4net.Internal.Quiet</c> application setting
- suppresses all internal logging including error messages.
- This setting should be set to <c>true</c> to enable message
- suppression.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.LogLog.OnLogReceived(System.Type,System.String,System.String,System.Exception)">
- <summary>
- Raises the LogReceived event when an internal messages is received.
- </summary>
- <param name="source"></param>
- <param name="prefix"></param>
- <param name="message"></param>
- <param name="exception"></param>
- </member>
- <member name="M:log4net.Util.LogLog.Debug(System.Type,System.String)">
- <summary>
- Writes log4net internal debug messages to the
- standard output stream.
- </summary>
- <param name="source"></param>
- <param name="message">The message to log.</param>
- <remarks>
- <para>
- All internal debug messages are prepended with
- the string "log4net: ".
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.LogLog.Debug(System.Type,System.String,System.Exception)">
- <summary>
- Writes log4net internal debug messages to the
- standard output stream.
- </summary>
- <param name="source">The Type that generated this message.</param>
- <param name="message">The message to log.</param>
- <param name="exception">An exception to log.</param>
- <remarks>
- <para>
- All internal debug messages are prepended with
- the string "log4net: ".
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.LogLog.Warn(System.Type,System.String)">
- <summary>
- Writes log4net internal warning messages to the
- standard error stream.
- </summary>
- <param name="source">The Type that generated this message.</param>
- <param name="message">The message to log.</param>
- <remarks>
- <para>
- All internal warning messages are prepended with
- the string "log4net:WARN ".
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.LogLog.Warn(System.Type,System.String,System.Exception)">
- <summary>
- Writes log4net internal warning messages to the
- standard error stream.
- </summary>
- <param name="source">The Type that generated this message.</param>
- <param name="message">The message to log.</param>
- <param name="exception">An exception to log.</param>
- <remarks>
- <para>
- All internal warning messages are prepended with
- the string "log4net:WARN ".
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.LogLog.Error(System.Type,System.String)">
- <summary>
- Writes log4net internal error messages to the
- standard error stream.
- </summary>
- <param name="source">The Type that generated this message.</param>
- <param name="message">The message to log.</param>
- <remarks>
- <para>
- All internal error messages are prepended with
- the string "log4net:ERROR ".
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.LogLog.Error(System.Type,System.String,System.Exception)">
- <summary>
- Writes log4net internal error messages to the
- standard error stream.
- </summary>
- <param name="source">The Type that generated this message.</param>
- <param name="message">The message to log.</param>
- <param name="exception">An exception to log.</param>
- <remarks>
- <para>
- All internal debug messages are prepended with
- the string "log4net:ERROR ".
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.LogLog.EmitOutLine(System.String)">
- <summary>
- Writes output to the standard output stream.
- </summary>
- <param name="message">The message to log.</param>
- <remarks>
- <para>
- Writes to both Console.Out and System.Diagnostics.Trace.
- Note that the System.Diagnostics.Trace is not supported
- on the Compact Framework.
- </para>
- <para>
- If the AppDomain is not configured with a config file then
- the call to System.Diagnostics.Trace may fail. This is only
- an issue if you are programmatically creating your own AppDomains.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.LogLog.EmitErrorLine(System.String)">
- <summary>
- Writes output to the standard error stream.
- </summary>
- <param name="message">The message to log.</param>
- <remarks>
- <para>
- Writes to both Console.Error and System.Diagnostics.Trace.
- Note that the System.Diagnostics.Trace is not supported
- on the Compact Framework.
- </para>
- <para>
- If the AppDomain is not configured with a config file then
- the call to System.Diagnostics.Trace may fail. This is only
- an issue if you are programmatically creating your own AppDomains.
- </para>
- </remarks>
- </member>
- <member name="F:log4net.Util.LogLog.s_debugEnabled">
- <summary>
- Default debug level
- </summary>
- </member>
- <member name="F:log4net.Util.LogLog.s_quietMode">
- <summary>
- In quietMode not even errors generate any output.
- </summary>
- </member>
- <member name="E:log4net.Util.LogLog.LogReceived">
- <summary>
- The event raised when an internal message has been received.
- </summary>
- </member>
- <member name="P:log4net.Util.LogLog.Source">
- <summary>
- The Type that generated the internal message.
- </summary>
- </member>
- <member name="P:log4net.Util.LogLog.TimeStamp">
- <summary>
- The DateTime stamp of when the internal message was received.
- </summary>
- </member>
- <member name="P:log4net.Util.LogLog.Prefix">
- <summary>
- A string indicating the severity of the internal message.
- </summary>
- <remarks>
- "log4net: ",
- "log4net:ERROR ",
- "log4net:WARN "
- </remarks>
- </member>
- <member name="P:log4net.Util.LogLog.Message">
- <summary>
- The internal log message.
- </summary>
- </member>
- <member name="P:log4net.Util.LogLog.Exception">
- <summary>
- The Exception related to the message.
- </summary>
- <remarks>
- Optional. Will be null if no Exception was passed.
- </remarks>
- </member>
- <member name="P:log4net.Util.LogLog.InternalDebugging">
- <summary>
- Gets or sets a value indicating whether log4net internal logging
- is enabled or disabled.
- </summary>
- <value>
- <c>true</c> if log4net internal logging is enabled, otherwise
- <c>false</c>.
- </value>
- <remarks>
- <para>
- When set to <c>true</c>, internal debug level logging will be
- displayed.
- </para>
- <para>
- This value can be set by setting the application setting
- <c>log4net.Internal.Debug</c> in the application configuration
- file.
- </para>
- <para>
- The default value is <c>false</c>, i.e. debugging is
- disabled.
- </para>
- </remarks>
- <example>
- <para>
- The following example enables internal debugging using the
- application configuration file :
- </para>
- <code lang="XML" escaped="true">
- <configuration>
- <appSettings>
- <add key="log4net.Internal.Debug" value="true" />
- </appSettings>
- </configuration>
- </code>
- </example>
- </member>
- <member name="P:log4net.Util.LogLog.QuietMode">
- <summary>
- Gets or sets a value indicating whether log4net should generate no output
- from internal logging, not even for errors.
- </summary>
- <value>
- <c>true</c> if log4net should generate no output at all from internal
- logging, otherwise <c>false</c>.
- </value>
- <remarks>
- <para>
- When set to <c>true</c> will cause internal logging at all levels to be
- suppressed. This means that no warning or error reports will be logged.
- This option overrides the <see cref="P:log4net.Util.LogLog.InternalDebugging"/> setting and
- disables all debug also.
- </para>
- <para>This value can be set by setting the application setting
- <c>log4net.Internal.Quiet</c> in the application configuration file.
- </para>
- <para>
- The default value is <c>false</c>, i.e. internal logging is not
- disabled.
- </para>
- </remarks>
- <example>
- The following example disables internal logging using the
- application configuration file :
- <code lang="XML" escaped="true">
- <configuration>
- <appSettings>
- <add key="log4net.Internal.Quiet" value="true"/>
- </appSettings>
- </configuration>
- </code>
- </example>
- </member>
- <member name="P:log4net.Util.LogLog.EmitInternalMessages">
- <summary>
-
- </summary>
- </member>
- <member name="P:log4net.Util.LogLog.IsDebugEnabled">
- <summary>
- Test if LogLog.Debug is enabled for output.
- </summary>
- <value>
- <c>true</c> if Debug is enabled
- </value>
- <remarks>
- <para>
- Test if LogLog.Debug is enabled for output.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Util.LogLog.IsWarnEnabled">
- <summary>
- Test if LogLog.Warn is enabled for output.
- </summary>
- <value>
- <c>true</c> if Warn is enabled
- </value>
- <remarks>
- <para>
- Test if LogLog.Warn is enabled for output.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Util.LogLog.IsErrorEnabled">
- <summary>
- Test if LogLog.Error is enabled for output.
- </summary>
- <value>
- <c>true</c> if Error is enabled
- </value>
- <remarks>
- <para>
- Test if LogLog.Error is enabled for output.
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Util.LogLog.LogReceivedAdapter">
- <summary>
- Subscribes to the LogLog.LogReceived event and stores messages
- to the supplied IList instance.
- </summary>
- </member>
- <member name="M:log4net.Util.LogLog.LogReceivedAdapter.#ctor(System.Collections.IList)">
- <summary>
-
- </summary>
- <param name="items"></param>
- </member>
- <member name="M:log4net.Util.LogLog.LogReceivedAdapter.Dispose">
- <summary>
-
- </summary>
- </member>
- <member name="P:log4net.Util.LogLog.LogReceivedAdapter.Items">
- <summary>
-
- </summary>
- </member>
- <member name="T:log4net.Util.LogReceivedEventArgs">
- <summary>
-
- </summary>
- </member>
- <member name="M:log4net.Util.LogReceivedEventArgs.#ctor(log4net.Util.LogLog)">
- <summary>
-
- </summary>
- <param name="loglog"></param>
- </member>
- <member name="P:log4net.Util.LogReceivedEventArgs.LogLog">
- <summary>
-
- </summary>
- </member>
- <member name="T:log4net.Util.NativeError">
- <summary>
- Represents a native error code and message.
- </summary>
- <remarks>
- <para>
- Represents a Win32 platform native error.
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- <author>Gert Driesen</author>
- </member>
- <member name="M:log4net.Util.NativeError.#ctor(System.Int32,System.String)">
- <summary>
- Create an instance of the <see cref="T:log4net.Util.NativeError"/> class with the specified
- error number and message.
- </summary>
- <param name="number">The number of the native error.</param>
- <param name="message">The message of the native error.</param>
- <remarks>
- <para>
- Create an instance of the <see cref="T:log4net.Util.NativeError"/> class with the specified
- error number and message.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.NativeError.GetLastError">
- <summary>
- Create a new instance of the <see cref="T:log4net.Util.NativeError"/> class for the last Windows error.
- </summary>
- <returns>
- An instance of the <see cref="T:log4net.Util.NativeError"/> class for the last windows error.
- </returns>
- <remarks>
- <para>
- The message for the <see cref="M:System.Runtime.InteropServices.Marshal.GetLastWin32Error"/> error number is lookup up using the
- native Win32 <c>FormatMessage</c> function.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.NativeError.GetError(System.Int32)">
- <summary>
- Create a new instance of the <see cref="T:log4net.Util.NativeError"/> class.
- </summary>
- <param name="number">the error number for the native error</param>
- <returns>
- An instance of the <see cref="T:log4net.Util.NativeError"/> class for the specified
- error number.
- </returns>
- <remarks>
- <para>
- The message for the specified error number is lookup up using the
- native Win32 <c>FormatMessage</c> function.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.NativeError.GetErrorMessage(System.Int32)">
- <summary>
- Retrieves the message corresponding with a Win32 message identifier.
- </summary>
- <param name="messageId">Message identifier for the requested message.</param>
- <returns>
- The message corresponding with the specified message identifier.
- </returns>
- <remarks>
- <para>
- The message will be searched for in system message-table resource(s)
- using the native <c>FormatMessage</c> function.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.NativeError.ToString">
- <summary>
- Return error information string
- </summary>
- <returns>error information string</returns>
- <remarks>
- <para>
- Return error information string
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.NativeError.FormatMessage(System.Int32,System.IntPtr@,System.Int32,System.Int32,System.String@,System.Int32,System.IntPtr)">
- <summary>
- Formats a message string.
- </summary>
- <param name="dwFlags">Formatting options, and how to interpret the <paramref name="lpSource" /> parameter.</param>
- <param name="lpSource">Location of the message definition.</param>
- <param name="dwMessageId">Message identifier for the requested message.</param>
- <param name="dwLanguageId">Language identifier for the requested message.</param>
- <param name="lpBuffer">If <paramref name="dwFlags" /> includes FORMAT_MESSAGE_ALLOCATE_BUFFER, the function allocates a buffer using the <c>LocalAlloc</c> function, and places the pointer to the buffer at the address specified in <paramref name="lpBuffer" />.</param>
- <param name="nSize">If the FORMAT_MESSAGE_ALLOCATE_BUFFER flag is not set, this parameter specifies the maximum number of TCHARs that can be stored in the output buffer. If FORMAT_MESSAGE_ALLOCATE_BUFFER is set, this parameter specifies the minimum number of TCHARs to allocate for an output buffer.</param>
- <param name="Arguments">Pointer to an array of values that are used as insert values in the formatted message.</param>
- <remarks>
- <para>
- The function requires a message definition as input. The message definition can come from a
- buffer passed into the function. It can come from a message table resource in an
- already-loaded module. Or the caller can ask the function to search the system's message
- table resource(s) for the message definition. The function finds the message definition
- in a message table resource based on a message identifier and a language identifier.
- The function copies the formatted message text to an output buffer, processing any embedded
- insert sequences if requested.
- </para>
- <para>
- To prevent the usage of unsafe code, this stub does not support inserting values in the formatted message.
- </para>
- </remarks>
- <returns>
- <para>
- If the function succeeds, the return value is the number of TCHARs stored in the output
- buffer, excluding the terminating null character.
- </para>
- <para>
- If the function fails, the return value is zero. To get extended error information,
- call <see cref="M:Marshal.GetLastWin32Error()" />.
- </para>
- </returns>
- </member>
- <member name="P:log4net.Util.NativeError.Number">
- <summary>
- Gets the number of the native error.
- </summary>
- <value>
- The number of the native error.
- </value>
- <remarks>
- <para>
- Gets the number of the native error.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Util.NativeError.Message">
- <summary>
- Gets the message of the native error.
- </summary>
- <value>
- The message of the native error.
- </value>
- <remarks>
- <para>
- </para>
- Gets the message of the native error.
- </remarks>
- </member>
- <member name="T:log4net.Util.NullDictionaryEnumerator">
- <summary>
- An always empty <see cref="T:System.Collections.IDictionaryEnumerator"/>.
- </summary>
- <remarks>
- <para>
- A singleton implementation of the <see cref="T:System.Collections.IDictionaryEnumerator"/> over a collection
- that is empty and not modifiable.
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- <author>Gert Driesen</author>
- </member>
- <member name="M:log4net.Util.NullDictionaryEnumerator.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:log4net.Util.NullDictionaryEnumerator"/> class.
- </summary>
- <remarks>
- <para>
- Uses a private access modifier to enforce the singleton pattern.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.NullDictionaryEnumerator.MoveNext">
- <summary>
- Test if the enumerator can advance, if so advance.
- </summary>
- <returns><c>false</c> as the <see cref="T:log4net.Util.NullDictionaryEnumerator"/> cannot advance.</returns>
- <remarks>
- <para>
- As the enumerator is over an empty collection its <see cref="P:log4net.Util.NullDictionaryEnumerator.Current"/>
- value cannot be moved over a valid position, therefore <see cref="M:log4net.Util.NullDictionaryEnumerator.MoveNext"/>
- will always return <c>false</c>.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.NullDictionaryEnumerator.Reset">
- <summary>
- Resets the enumerator back to the start.
- </summary>
- <remarks>
- <para>
- As the enumerator is over an empty collection <see cref="M:log4net.Util.NullDictionaryEnumerator.Reset"/> does nothing.
- </para>
- </remarks>
- </member>
- <member name="F:log4net.Util.NullDictionaryEnumerator.s_instance">
- <summary>
- The singleton instance of the <see cref="T:log4net.Util.NullDictionaryEnumerator"/>.
- </summary>
- </member>
- <member name="P:log4net.Util.NullDictionaryEnumerator.Instance">
- <summary>
- Gets the singleton instance of the <see cref="T:log4net.Util.NullDictionaryEnumerator"/>.
- </summary>
- <returns>The singleton instance of the <see cref="T:log4net.Util.NullDictionaryEnumerator"/>.</returns>
- <remarks>
- <para>
- Gets the singleton instance of the <see cref="T:log4net.Util.NullDictionaryEnumerator"/>.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Util.NullDictionaryEnumerator.Current">
- <summary>
- Gets the current object from the enumerator.
- </summary>
- <remarks>
- Throws an <see cref="T:System.InvalidOperationException"/> because the
- <see cref="T:log4net.Util.NullDictionaryEnumerator"/> never has a current value.
- </remarks>
- <remarks>
- <para>
- As the enumerator is over an empty collection its <see cref="P:log4net.Util.NullDictionaryEnumerator.Current"/>
- value cannot be moved over a valid position, therefore <see cref="P:log4net.Util.NullDictionaryEnumerator.Current"/>
- will throw an <see cref="T:System.InvalidOperationException"/>.
- </para>
- </remarks>
- <exception cref="T:System.InvalidOperationException">The collection is empty and <see cref="P:log4net.Util.NullDictionaryEnumerator.Current"/>
- cannot be positioned over a valid location.</exception>
- </member>
- <member name="P:log4net.Util.NullDictionaryEnumerator.Key">
- <summary>
- Gets the current key from the enumerator.
- </summary>
- <remarks>
- Throws an exception because the <see cref="T:log4net.Util.NullDictionaryEnumerator"/>
- never has a current value.
- </remarks>
- <remarks>
- <para>
- As the enumerator is over an empty collection its <see cref="P:log4net.Util.NullDictionaryEnumerator.Current"/>
- value cannot be moved over a valid position, therefore <see cref="P:log4net.Util.NullDictionaryEnumerator.Key"/>
- will throw an <see cref="T:System.InvalidOperationException"/>.
- </para>
- </remarks>
- <exception cref="T:System.InvalidOperationException">The collection is empty and <see cref="P:log4net.Util.NullDictionaryEnumerator.Current"/>
- cannot be positioned over a valid location.</exception>
- </member>
- <member name="P:log4net.Util.NullDictionaryEnumerator.Value">
- <summary>
- Gets the current value from the enumerator.
- </summary>
- <value>The current value from the enumerator.</value>
- <remarks>
- Throws an <see cref="T:System.InvalidOperationException"/> because the
- <see cref="T:log4net.Util.NullDictionaryEnumerator"/> never has a current value.
- </remarks>
- <remarks>
- <para>
- As the enumerator is over an empty collection its <see cref="P:log4net.Util.NullDictionaryEnumerator.Current"/>
- value cannot be moved over a valid position, therefore <see cref="P:log4net.Util.NullDictionaryEnumerator.Value"/>
- will throw an <see cref="T:System.InvalidOperationException"/>.
- </para>
- </remarks>
- <exception cref="T:System.InvalidOperationException">The collection is empty and <see cref="P:log4net.Util.NullDictionaryEnumerator.Current"/>
- cannot be positioned over a valid location.</exception>
- </member>
- <member name="P:log4net.Util.NullDictionaryEnumerator.Entry">
- <summary>
- Gets the current entry from the enumerator.
- </summary>
- <remarks>
- Throws an <see cref="T:System.InvalidOperationException"/> because the
- <see cref="T:log4net.Util.NullDictionaryEnumerator"/> never has a current entry.
- </remarks>
- <remarks>
- <para>
- As the enumerator is over an empty collection its <see cref="P:log4net.Util.NullDictionaryEnumerator.Current"/>
- value cannot be moved over a valid position, therefore <see cref="P:log4net.Util.NullDictionaryEnumerator.Entry"/>
- will throw an <see cref="T:System.InvalidOperationException"/>.
- </para>
- </remarks>
- <exception cref="T:System.InvalidOperationException">The collection is empty and <see cref="P:log4net.Util.NullDictionaryEnumerator.Current"/>
- cannot be positioned over a valid location.</exception>
- </member>
- <member name="T:log4net.Util.NullEnumerator">
- <summary>
- An always empty <see cref="T:System.Collections.IEnumerator"/>.
- </summary>
- <remarks>
- <para>
- A singleton implementation of the <see cref="T:System.Collections.IEnumerator"/> over a collection
- that is empty and not modifiable.
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- <author>Gert Driesen</author>
- </member>
- <member name="M:log4net.Util.NullEnumerator.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:log4net.Util.NullEnumerator"/> class.
- </summary>
- <remarks>
- <para>
- Uses a private access modifier to enforce the singleton pattern.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.NullEnumerator.MoveNext">
- <summary>
- Test if the enumerator can advance, if so advance
- </summary>
- <returns><c>false</c> as the <see cref="T:log4net.Util.NullEnumerator"/> cannot advance.</returns>
- <remarks>
- <para>
- As the enumerator is over an empty collection its <see cref="P:log4net.Util.NullEnumerator.Current"/>
- value cannot be moved over a valid position, therefore <see cref="M:log4net.Util.NullEnumerator.MoveNext"/>
- will always return <c>false</c>.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.NullEnumerator.Reset">
- <summary>
- Resets the enumerator back to the start.
- </summary>
- <remarks>
- <para>
- As the enumerator is over an empty collection <see cref="M:log4net.Util.NullEnumerator.Reset"/> does nothing.
- </para>
- </remarks>
- </member>
- <member name="F:log4net.Util.NullEnumerator.s_instance">
- <summary>
- The singleton instance of the <see cref="T:log4net.Util.NullEnumerator"/>.
- </summary>
- </member>
- <member name="P:log4net.Util.NullEnumerator.Instance">
- <summary>
- Get the singleton instance of the <see cref="T:log4net.Util.NullEnumerator"/>.
- </summary>
- <returns>The singleton instance of the <see cref="T:log4net.Util.NullEnumerator"/>.</returns>
- <remarks>
- <para>
- Gets the singleton instance of the <see cref="T:log4net.Util.NullEnumerator"/>.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Util.NullEnumerator.Current">
- <summary>
- Gets the current object from the enumerator.
- </summary>
- <remarks>
- Throws an <see cref="T:System.InvalidOperationException"/> because the
- <see cref="T:log4net.Util.NullDictionaryEnumerator"/> never has a current value.
- </remarks>
- <remarks>
- <para>
- As the enumerator is over an empty collection its <see cref="P:log4net.Util.NullEnumerator.Current"/>
- value cannot be moved over a valid position, therefore <see cref="P:log4net.Util.NullEnumerator.Current"/>
- will throw an <see cref="T:System.InvalidOperationException"/>.
- </para>
- </remarks>
- <exception cref="T:System.InvalidOperationException">The collection is empty and <see cref="P:log4net.Util.NullEnumerator.Current"/>
- cannot be positioned over a valid location.</exception>
- </member>
- <member name="T:log4net.Util.NullSecurityContext">
- <summary>
- A SecurityContext used when a SecurityContext is not required
- </summary>
- <remarks>
- <para>
- The <see cref="T:log4net.Util.NullSecurityContext"/> is a no-op implementation of the
- <see cref="T:log4net.Core.SecurityContext"/> base class. It is used where a <see cref="T:log4net.Core.SecurityContext"/>
- is required but one has not been provided.
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- </member>
- <member name="F:log4net.Util.NullSecurityContext.Instance">
- <summary>
- Singleton instance of <see cref="T:log4net.Util.NullSecurityContext"/>
- </summary>
- <remarks>
- <para>
- Singleton instance of <see cref="T:log4net.Util.NullSecurityContext"/>
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.NullSecurityContext.#ctor">
- <summary>
- Private constructor
- </summary>
- <remarks>
- <para>
- Private constructor for singleton pattern.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.NullSecurityContext.Impersonate(System.Object)">
- <summary>
- Impersonate this SecurityContext
- </summary>
- <param name="state">State supplied by the caller</param>
- <returns><c>null</c></returns>
- <remarks>
- <para>
- No impersonation is done and <c>null</c> is always returned.
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Util.OnlyOnceErrorHandler">
- <summary>
- Implements log4net's default error handling policy which consists
- of emitting a message for the first error in an appender and
- ignoring all subsequent errors.
- </summary>
- <remarks>
- <para>
- The error message is processed using the LogLog sub-system by default.
- </para>
- <para>
- This policy aims at protecting an otherwise working application
- from being flooded with error messages when logging fails.
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- <author>Gert Driesen</author>
- <author>Ron Grabowski</author>
- </member>
- <member name="M:log4net.Util.OnlyOnceErrorHandler.#ctor">
- <summary>
- Default Constructor
- </summary>
- <remarks>
- <para>
- Initializes a new instance of the <see cref="T:log4net.Util.OnlyOnceErrorHandler"/> class.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.OnlyOnceErrorHandler.#ctor(System.String)">
- <summary>
- Constructor
- </summary>
- <param name="prefix">The prefix to use for each message.</param>
- <remarks>
- <para>
- Initializes a new instance of the <see cref="T:log4net.Util.OnlyOnceErrorHandler"/> class
- with the specified prefix.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.OnlyOnceErrorHandler.Reset">
- <summary>
- Reset the error handler back to its initial disabled state.
- </summary>
- </member>
- <member name="M:log4net.Util.OnlyOnceErrorHandler.Error(System.String,System.Exception,log4net.Core.ErrorCode)">
- <summary>
- Log an Error
- </summary>
- <param name="message">The error message.</param>
- <param name="e">The exception.</param>
- <param name="errorCode">The internal error code.</param>
- <remarks>
- <para>
- Invokes <see cref="M:log4net.Util.OnlyOnceErrorHandler.FirstError(System.String,System.Exception,log4net.Core.ErrorCode)"/> if and only if this is the first error or the first error after <see cref="M:log4net.Util.OnlyOnceErrorHandler.Reset"/> has been called.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.OnlyOnceErrorHandler.FirstError(System.String,System.Exception,log4net.Core.ErrorCode)">
- <summary>
- Log the very first error
- </summary>
- <param name="message">The error message.</param>
- <param name="e">The exception.</param>
- <param name="errorCode">The internal error code.</param>
- <remarks>
- <para>
- Sends the error information to <see cref="T:log4net.Util.LogLog"/>'s Error method.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.OnlyOnceErrorHandler.Error(System.String,System.Exception)">
- <summary>
- Log an Error
- </summary>
- <param name="message">The error message.</param>
- <param name="e">The exception.</param>
- <remarks>
- <para>
- Invokes <see cref="M:log4net.Util.OnlyOnceErrorHandler.FirstError(System.String,System.Exception,log4net.Core.ErrorCode)"/> if and only if this is the first error or the first error after <see cref="M:log4net.Util.OnlyOnceErrorHandler.Reset"/> has been called.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.OnlyOnceErrorHandler.Error(System.String)">
- <summary>
- Log an error
- </summary>
- <param name="message">The error message.</param>
- <remarks>
- <para>
- Invokes <see cref="M:log4net.Util.OnlyOnceErrorHandler.FirstError(System.String,System.Exception,log4net.Core.ErrorCode)"/> if and only if this is the first error or the first error after <see cref="M:log4net.Util.OnlyOnceErrorHandler.Reset"/> has been called.
- </para>
- </remarks>
- </member>
- <member name="F:log4net.Util.OnlyOnceErrorHandler.m_enabledDate">
- <summary>
- The date the error was recorded.
- </summary>
- </member>
- <member name="F:log4net.Util.OnlyOnceErrorHandler.m_firstTime">
- <summary>
- Flag to indicate if it is the first error
- </summary>
- </member>
- <member name="F:log4net.Util.OnlyOnceErrorHandler.m_message">
- <summary>
- The message recorded during the first error.
- </summary>
- </member>
- <member name="F:log4net.Util.OnlyOnceErrorHandler.m_exception">
- <summary>
- The exception recorded during the first error.
- </summary>
- </member>
- <member name="F:log4net.Util.OnlyOnceErrorHandler.m_errorCode">
- <summary>
- The error code recorded during the first error.
- </summary>
- </member>
- <member name="F:log4net.Util.OnlyOnceErrorHandler.m_prefix">
- <summary>
- String to prefix each message with
- </summary>
- </member>
- <member name="F:log4net.Util.OnlyOnceErrorHandler.declaringType">
- <summary>
- The fully qualified type of the OnlyOnceErrorHandler class.
- </summary>
- <remarks>
- Used by the internal logger to record the Type of the
- log message.
- </remarks>
- </member>
- <member name="P:log4net.Util.OnlyOnceErrorHandler.IsEnabled">
- <summary>
- Is error logging enabled
- </summary>
- <remarks>
- <para>
- Is error logging enabled. Logging is only enabled for the
- first error delivered to the <see cref="T:log4net.Util.OnlyOnceErrorHandler"/>.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Util.OnlyOnceErrorHandler.EnabledDate">
- <summary>
- The date the first error that trigged this error handler occured.
- </summary>
- </member>
- <member name="P:log4net.Util.OnlyOnceErrorHandler.ErrorMessage">
- <summary>
- The message from the first error that trigged this error handler.
- </summary>
- </member>
- <member name="P:log4net.Util.OnlyOnceErrorHandler.Exception">
- <summary>
- The exception from the first error that trigged this error handler.
- </summary>
- <remarks>
- May be <see langword="null" />.
- </remarks>
- </member>
- <member name="P:log4net.Util.OnlyOnceErrorHandler.ErrorCode">
- <summary>
- The error code from the first error that trigged this error handler.
- </summary>
- <remarks>
- Defaults to <see cref="F:log4net.Core.ErrorCode.GenericFailure"/>
- </remarks>
- </member>
- <member name="T:log4net.Util.OptionConverter">
- <summary>
- A convenience class to convert property values to specific types.
- </summary>
- <remarks>
- <para>
- Utility functions for converting types and parsing values.
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- <author>Gert Driesen</author>
- </member>
- <member name="M:log4net.Util.OptionConverter.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:log4net.Util.OptionConverter"/> class.
- </summary>
- <remarks>
- <para>
- Uses a private access modifier to prevent instantiation of this class.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.OptionConverter.ToBoolean(System.String,System.Boolean)">
- <summary>
- Converts a string to a <see cref="T:System.Boolean"/> value.
- </summary>
- <param name="argValue">String to convert.</param>
- <param name="defaultValue">The default value.</param>
- <returns>The <see cref="T:System.Boolean"/> value of <paramref name="argValue"/>.</returns>
- <remarks>
- <para>
- If <paramref name="argValue"/> is "true", then <c>true</c> is returned.
- If <paramref name="argValue"/> is "false", then <c>false</c> is returned.
- Otherwise, <paramref name="defaultValue"/> is returned.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.OptionConverter.ToFileSize(System.String,System.Int64)">
- <summary>
- Parses a file size into a number.
- </summary>
- <param name="argValue">String to parse.</param>
- <param name="defaultValue">The default value.</param>
- <returns>The <see cref="T:System.Int64"/> value of <paramref name="argValue"/>.</returns>
- <remarks>
- <para>
- Parses a file size of the form: number[KB|MB|GB] into a
- long value. It is scaled with the appropriate multiplier.
- </para>
- <para>
- <paramref name="defaultValue"/> is returned when <paramref name="argValue"/>
- cannot be converted to a <see cref="T:System.Int64"/> value.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.OptionConverter.ConvertStringTo(System.Type,System.String)">
- <summary>
- Converts a string to an object.
- </summary>
- <param name="target">The target type to convert to.</param>
- <param name="txt">The string to convert to an object.</param>
- <returns>
- The object converted from a string or <c>null</c> when the
- conversion failed.
- </returns>
- <remarks>
- <para>
- Converts a string to an object. Uses the converter registry to try
- to convert the string value into the specified target type.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.OptionConverter.CanConvertTypeTo(System.Type,System.Type)">
- <summary>
- Checks if there is an appropriate type conversion from the source type to the target type.
- </summary>
- <param name="sourceType">The type to convert from.</param>
- <param name="targetType">The type to convert to.</param>
- <returns><c>true</c> if there is a conversion from the source type to the target type.</returns>
- <remarks>
- Checks if there is an appropriate type conversion from the source type to the target type.
- <para>
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.OptionConverter.ConvertTypeTo(System.Object,System.Type)">
- <summary>
- Converts an object to the target type.
- </summary>
- <param name="sourceInstance">The object to convert to the target type.</param>
- <param name="targetType">The type to convert to.</param>
- <returns>The converted object.</returns>
- <remarks>
- <para>
- Converts an object to the target type.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.OptionConverter.InstantiateByClassName(System.String,System.Type,System.Object)">
- <summary>
- Instantiates an object given a class name.
- </summary>
- <param name="className">The fully qualified class name of the object to instantiate.</param>
- <param name="superClass">The class to which the new object should belong.</param>
- <param name="defaultValue">The object to return in case of non-fulfillment.</param>
- <returns>
- An instance of the <paramref name="className"/> or <paramref name="defaultValue"/>
- if the object could not be instantiated.
- </returns>
- <remarks>
- <para>
- Checks that the <paramref name="className"/> is a subclass of
- <paramref name="superClass"/>. If that test fails or the object could
- not be instantiated, then <paramref name="defaultValue"/> is returned.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.OptionConverter.SubstituteVariables(System.String,System.Collections.IDictionary)">
- <summary>
- Performs variable substitution in string <paramref name="value"/> from the
- values of keys found in <paramref name="props"/>.
- </summary>
- <param name="value">The string on which variable substitution is performed.</param>
- <param name="props">The dictionary to use to lookup variables.</param>
- <returns>The result of the substitutions.</returns>
- <remarks>
- <para>
- The variable substitution delimiters are <b>${</b> and <b>}</b>.
- </para>
- <para>
- For example, if props contains <c>key=value</c>, then the call
- </para>
- <para>
- <code lang="C#">
- string s = OptionConverter.SubstituteVariables("Value of key is ${key}.");
- </code>
- </para>
- <para>
- will set the variable <c>s</c> to "Value of key is value.".
- </para>
- <para>
- If no value could be found for the specified key, then substitution
- defaults to an empty string.
- </para>
- <para>
- For example, if system properties contains no value for the key
- "nonExistentKey", then the call
- </para>
- <para>
- <code lang="C#">
- string s = OptionConverter.SubstituteVariables("Value of nonExistentKey is [${nonExistentKey}]");
- </code>
- </para>
- <para>
- will set <s>s</s> to "Value of nonExistentKey is []".
- </para>
- <para>
- An Exception is thrown if <paramref name="value"/> contains a start
- delimiter "${" which is not balanced by a stop delimiter "}".
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.OptionConverter.ParseEnum(System.Type,System.String,System.Boolean)">
- <summary>
- Converts the string representation of the name or numeric value of one or
- more enumerated constants to an equivalent enumerated object.
- </summary>
- <param name="enumType">The type to convert to.</param>
- <param name="value">The enum string value.</param>
- <param name="ignoreCase">If <c>true</c>, ignore case; otherwise, regard case.</param>
- <returns>An object of type <paramref name="enumType" /> whose value is represented by <paramref name="value" />.</returns>
- </member>
- <member name="F:log4net.Util.OptionConverter.declaringType">
- <summary>
- The fully qualified type of the OptionConverter class.
- </summary>
- <remarks>
- Used by the internal logger to record the Type of the
- log message.
- </remarks>
- </member>
- <member name="T:log4net.Util.PatternParser">
- <summary>
- Most of the work of the <see cref="T:log4net.Layout.PatternLayout"/> class
- is delegated to the PatternParser class.
- </summary>
- <remarks>
- <para>
- The <c>PatternParser</c> processes a pattern string and
- returns a chain of <see cref="T:log4net.Util.PatternConverter"/> objects.
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- <author>Gert Driesen</author>
- </member>
- <member name="M:log4net.Util.PatternParser.#ctor(System.String)">
- <summary>
- Constructor
- </summary>
- <param name="pattern">The pattern to parse.</param>
- <remarks>
- <para>
- Initializes a new instance of the <see cref="T:log4net.Util.PatternParser"/> class
- with the specified pattern string.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.PatternParser.Parse">
- <summary>
- Parses the pattern into a chain of pattern converters.
- </summary>
- <returns>The head of a chain of pattern converters.</returns>
- <remarks>
- <para>
- Parses the pattern into a chain of pattern converters.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.PatternParser.BuildCache">
- <summary>
- Build the unified cache of converters from the static and instance maps
- </summary>
- <returns>the list of all the converter names</returns>
- <remarks>
- <para>
- Build the unified cache of converters from the static and instance maps
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.PatternParser.ParseInternal(System.String,System.String[])">
- <summary>
- Internal method to parse the specified pattern to find specified matches
- </summary>
- <param name="pattern">the pattern to parse</param>
- <param name="matches">the converter names to match in the pattern</param>
- <remarks>
- <para>
- The matches param must be sorted such that longer strings come before shorter ones.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.PatternParser.ProcessLiteral(System.String)">
- <summary>
- Process a parsed literal
- </summary>
- <param name="text">the literal text</param>
- </member>
- <member name="M:log4net.Util.PatternParser.ProcessConverter(System.String,System.String,log4net.Util.FormattingInfo)">
- <summary>
- Process a parsed converter pattern
- </summary>
- <param name="converterName">the name of the converter</param>
- <param name="option">the optional option for the converter</param>
- <param name="formattingInfo">the formatting info for the converter</param>
- </member>
- <member name="M:log4net.Util.PatternParser.AddConverter(log4net.Util.PatternConverter)">
- <summary>
- Resets the internal state of the parser and adds the specified pattern converter
- to the chain.
- </summary>
- <param name="pc">The pattern converter to add.</param>
- </member>
- <member name="F:log4net.Util.PatternParser.m_head">
- <summary>
- The first pattern converter in the chain
- </summary>
- </member>
- <member name="F:log4net.Util.PatternParser.m_tail">
- <summary>
- the last pattern converter in the chain
- </summary>
- </member>
- <member name="F:log4net.Util.PatternParser.m_pattern">
- <summary>
- The pattern
- </summary>
- </member>
- <member name="F:log4net.Util.PatternParser.m_patternConverters">
- <summary>
- Internal map of converter identifiers to converter types
- </summary>
- <remarks>
- <para>
- This map overrides the static s_globalRulesRegistry map.
- </para>
- </remarks>
- </member>
- <member name="F:log4net.Util.PatternParser.declaringType">
- <summary>
- The fully qualified type of the PatternParser class.
- </summary>
- <remarks>
- Used by the internal logger to record the Type of the
- log message.
- </remarks>
- </member>
- <member name="P:log4net.Util.PatternParser.PatternConverters">
- <summary>
- Get the converter registry used by this parser
- </summary>
- <value>
- The converter registry used by this parser
- </value>
- <remarks>
- <para>
- Get the converter registry used by this parser
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Util.PatternParser.StringLengthComparer">
- <summary>
- Sort strings by length
- </summary>
- <remarks>
- <para>
- <see cref="T:System.Collections.IComparer"/> that orders strings by string length.
- The longest strings are placed first
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Util.PatternString">
- <summary>
- This class implements a patterned string.
- </summary>
- <remarks>
- <para>
- This string has embedded patterns that are resolved and expanded
- when the string is formatted.
- </para>
- <para>
- This class functions similarly to the <see cref="T:log4net.Layout.PatternLayout"/>
- in that it accepts a pattern and renders it to a string. Unlike the
- <see cref="T:log4net.Layout.PatternLayout"/> however the <c>PatternString</c>
- does not render the properties of a specific <see cref="T:log4net.Core.LoggingEvent"/> but
- of the process in general.
- </para>
- <para>
- The recognized conversion pattern names are:
- </para>
- <list type="table">
- <listheader>
- <term>Conversion Pattern Name</term>
- <description>Effect</description>
- </listheader>
- <item>
- <term>appdomain</term>
- <description>
- <para>
- Used to output the friendly name of the current AppDomain.
- </para>
- </description>
- </item>
- <item>
- <term>date</term>
- <description>
- <para>
- Used to output the current date and time in the local time zone.
- To output the date in universal time use the <c>%utcdate</c> pattern.
- The date conversion
- specifier may be followed by a <i>date format specifier</i> enclosed
- between braces. For example, <b>%date{HH:mm:ss,fff}</b> or
- <b>%date{dd MMM yyyy HH:mm:ss,fff}</b>. If no date format specifier is
- given then ISO8601 format is
- assumed (<see cref="T:log4net.DateFormatter.Iso8601DateFormatter"/>).
- </para>
- <para>
- The date format specifier admits the same syntax as the
- time pattern string of the <see cref="M:DateTime.ToString(string)"/>.
- </para>
- <para>
- For better results it is recommended to use the log4net date
- formatters. These can be specified using one of the strings
- "ABSOLUTE", "DATE" and "ISO8601" for specifying
- <see cref="T:log4net.DateFormatter.AbsoluteTimeDateFormatter"/>,
- <see cref="T:log4net.DateFormatter.DateTimeDateFormatter"/> and respectively
- <see cref="T:log4net.DateFormatter.Iso8601DateFormatter"/>. For example,
- <b>%date{ISO8601}</b> or <b>%date{ABSOLUTE}</b>.
- </para>
- <para>
- These dedicated date formatters perform significantly
- better than <see cref="M:DateTime.ToString(string)"/>.
- </para>
- </description>
- </item>
- <item>
- <term>env</term>
- <description>
- <para>
- Used to output the a specific environment variable. The key to
- lookup must be specified within braces and directly following the
- pattern specifier, e.g. <b>%env{COMPUTERNAME}</b> would include the value
- of the <c>COMPUTERNAME</c> environment variable.
- </para>
- <para>
- The <c>env</c> pattern is not supported on the .NET Compact Framework.
- </para>
- </description>
- </item>
- <item>
- <term>identity</term>
- <description>
- <para>
- Used to output the user name for the currently active user
- (Principal.Identity.Name).
- </para>
- </description>
- </item>
- <item>
- <term>newline</term>
- <description>
- <para>
- Outputs the platform dependent line separator character or
- characters.
- </para>
- <para>
- This conversion pattern name offers the same performance as using
- non-portable line separator strings such as "\n", or "\r\n".
- Thus, it is the preferred way of specifying a line separator.
- </para>
- </description>
- </item>
- <item>
- <term>processid</term>
- <description>
- <para>
- Used to output the system process ID for the current process.
- </para>
- </description>
- </item>
- <item>
- <term>property</term>
- <description>
- <para>
- Used to output a specific context property. The key to
- lookup must be specified within braces and directly following the
- pattern specifier, e.g. <b>%property{user}</b> would include the value
- from the property that is keyed by the string 'user'. Each property value
- that is to be included in the log must be specified separately.
- Properties are stored in logging contexts. By default
- the <c>log4net:HostName</c> property is set to the name of machine on
- which the event was originally logged.
- </para>
- <para>
- If no key is specified, e.g. <b>%property</b> then all the keys and their
- values are printed in a comma separated list.
- </para>
- <para>
- The properties of an event are combined from a number of different
- contexts. These are listed below in the order in which they are searched.
- </para>
- <list type="definition">
- <item>
- <term>the thread properties</term>
- <description>
- The <see cref="P:log4net.ThreadContext.Properties"/> that are set on the current
- thread. These properties are shared by all events logged on this thread.
- </description>
- </item>
- <item>
- <term>the global properties</term>
- <description>
- The <see cref="P:log4net.GlobalContext.Properties"/> that are set globally. These
- properties are shared by all the threads in the AppDomain.
- </description>
- </item>
- </list>
- </description>
- </item>
- <item>
- <term>random</term>
- <description>
- <para>
- Used to output a random string of characters. The string is made up of
- uppercase letters and numbers. By default the string is 4 characters long.
- The length of the string can be specified within braces directly following the
- pattern specifier, e.g. <b>%random{8}</b> would output an 8 character string.
- </para>
- </description>
- </item>
- <item>
- <term>username</term>
- <description>
- <para>
- Used to output the WindowsIdentity for the currently
- active user.
- </para>
- </description>
- </item>
- <item>
- <term>utcdate</term>
- <description>
- <para>
- Used to output the date of the logging event in universal time.
- The date conversion
- specifier may be followed by a <i>date format specifier</i> enclosed
- between braces. For example, <b>%utcdate{HH:mm:ss,fff}</b> or
- <b>%utcdate{dd MMM yyyy HH:mm:ss,fff}</b>. If no date format specifier is
- given then ISO8601 format is
- assumed (<see cref="T:log4net.DateFormatter.Iso8601DateFormatter"/>).
- </para>
- <para>
- The date format specifier admits the same syntax as the
- time pattern string of the <see cref="M:DateTime.ToString(string)"/>.
- </para>
- <para>
- For better results it is recommended to use the log4net date
- formatters. These can be specified using one of the strings
- "ABSOLUTE", "DATE" and "ISO8601" for specifying
- <see cref="T:log4net.DateFormatter.AbsoluteTimeDateFormatter"/>,
- <see cref="T:log4net.DateFormatter.DateTimeDateFormatter"/> and respectively
- <see cref="T:log4net.DateFormatter.Iso8601DateFormatter"/>. For example,
- <b>%utcdate{ISO8601}</b> or <b>%utcdate{ABSOLUTE}</b>.
- </para>
- <para>
- These dedicated date formatters perform significantly
- better than <see cref="M:DateTime.ToString(string)"/>.
- </para>
- </description>
- </item>
- <item>
- <term>%</term>
- <description>
- <para>
- The sequence %% outputs a single percent sign.
- </para>
- </description>
- </item>
- </list>
- <para>
- Additional pattern converters may be registered with a specific <see cref="T:log4net.Util.PatternString"/>
- instance using <see cref="M:AddConverter(ConverterInfo)"/> or
- <see cref="M:AddConverter(string, Type)"/>.
- </para>
- <para>
- See the <see cref="T:log4net.Layout.PatternLayout"/> for details on the
- <i>format modifiers</i> supported by the patterns.
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- </member>
- <member name="F:log4net.Util.PatternString.s_globalRulesRegistry">
- <summary>
- Internal map of converter identifiers to converter types.
- </summary>
- </member>
- <member name="F:log4net.Util.PatternString.m_pattern">
- <summary>
- the pattern
- </summary>
- </member>
- <member name="F:log4net.Util.PatternString.m_head">
- <summary>
- the head of the pattern converter chain
- </summary>
- </member>
- <member name="F:log4net.Util.PatternString.m_instanceRulesRegistry">
- <summary>
- patterns defined on this PatternString only
- </summary>
- </member>
- <member name="M:log4net.Util.PatternString.#cctor">
- <summary>
- Initialize the global registry
- </summary>
- </member>
- <member name="M:log4net.Util.PatternString.#ctor">
- <summary>
- Default constructor
- </summary>
- <remarks>
- <para>
- Initialize a new instance of <see cref="T:log4net.Util.PatternString"/>
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.PatternString.#ctor(System.String)">
- <summary>
- Constructs a PatternString
- </summary>
- <param name="pattern">The pattern to use with this PatternString</param>
- <remarks>
- <para>
- Initialize a new instance of <see cref="T:log4net.Util.PatternString"/> with the pattern specified.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.PatternString.ActivateOptions">
- <summary>
- Initialize object options
- </summary>
- <remarks>
- <para>
- This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
- activation scheme. The <see cref="M:log4net.Util.PatternString.ActivateOptions"/> method must
- be called on this object after the configuration properties have
- been set. Until <see cref="M:log4net.Util.PatternString.ActivateOptions"/> is called this
- object is in an undefined state and must not be used.
- </para>
- <para>
- If any of the configuration properties are modified then
- <see cref="M:log4net.Util.PatternString.ActivateOptions"/> must be called again.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.PatternString.CreatePatternParser(System.String)">
- <summary>
- Create the <see cref="T:log4net.Util.PatternParser"/> used to parse the pattern
- </summary>
- <param name="pattern">the pattern to parse</param>
- <returns>The <see cref="T:log4net.Util.PatternParser"/></returns>
- <remarks>
- <para>
- Returns PatternParser used to parse the conversion string. Subclasses
- may override this to return a subclass of PatternParser which recognize
- custom conversion pattern name.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.PatternString.Format(System.IO.TextWriter)">
- <summary>
- Produces a formatted string as specified by the conversion pattern.
- </summary>
- <param name="writer">The TextWriter to write the formatted event to</param>
- <remarks>
- <para>
- Format the pattern to the <paramref name="writer"/>.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.PatternString.Format">
- <summary>
- Format the pattern as a string
- </summary>
- <returns>the pattern formatted as a string</returns>
- <remarks>
- <para>
- Format the pattern to a string.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.PatternString.AddConverter(log4net.Util.ConverterInfo)">
- <summary>
- Add a converter to this PatternString
- </summary>
- <param name="converterInfo">the converter info</param>
- <remarks>
- <para>
- This version of the method is used by the configurator.
- Programmatic users should use the alternative <see cref="M:AddConverter(string,Type)"/> method.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.PatternString.AddConverter(System.String,System.Type)">
- <summary>
- Add a converter to this PatternString
- </summary>
- <param name="name">the name of the conversion pattern for this converter</param>
- <param name="type">the type of the converter</param>
- <remarks>
- <para>
- Add a converter to this PatternString
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Util.PatternString.ConversionPattern">
- <summary>
- Gets or sets the pattern formatting string
- </summary>
- <value>
- The pattern formatting string
- </value>
- <remarks>
- <para>
- The <b>ConversionPattern</b> option. This is the string which
- controls formatting and consists of a mix of literal content and
- conversion specifiers.
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Util.PropertiesDictionary">
- <summary>
- String keyed object map.
- </summary>
- <remarks>
- <para>
- While this collection is serializable only member
- objects that are serializable will
- be serialized along with this collection.
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- <author>Gert Driesen</author>
- </member>
- <member name="T:log4net.Util.ReadOnlyPropertiesDictionary">
- <summary>
- String keyed object map that is read only.
- </summary>
- <remarks>
- <para>
- This collection is readonly and cannot be modified.
- </para>
- <para>
- While this collection is serializable only member
- objects that are serializable will
- be serialized along with this collection.
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- <author>Gert Driesen</author>
- </member>
- <member name="F:log4net.Util.ReadOnlyPropertiesDictionary.m_hashtable">
- <summary>
- The Hashtable used to store the properties data
- </summary>
- </member>
- <member name="M:log4net.Util.ReadOnlyPropertiesDictionary.#ctor">
- <summary>
- Constructor
- </summary>
- <remarks>
- <para>
- Initializes a new instance of the <see cref="T:log4net.Util.ReadOnlyPropertiesDictionary"/> class.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.ReadOnlyPropertiesDictionary.#ctor(log4net.Util.ReadOnlyPropertiesDictionary)">
- <summary>
- Copy Constructor
- </summary>
- <param name="propertiesDictionary">properties to copy</param>
- <remarks>
- <para>
- Initializes a new instance of the <see cref="T:log4net.Util.ReadOnlyPropertiesDictionary"/> class.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.ReadOnlyPropertiesDictionary.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Deserialization constructor
- </summary>
- <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data.</param>
- <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
- <remarks>
- <para>
- Initializes a new instance of the <see cref="T:log4net.Util.ReadOnlyPropertiesDictionary"/> class
- with serialized data.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.ReadOnlyPropertiesDictionary.GetKeys">
- <summary>
- Gets the key names.
- </summary>
- <returns>An array of all the keys.</returns>
- <remarks>
- <para>
- Gets the key names.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.ReadOnlyPropertiesDictionary.Contains(System.String)">
- <summary>
- Test if the dictionary contains a specified key
- </summary>
- <param name="key">the key to look for</param>
- <returns>true if the dictionary contains the specified key</returns>
- <remarks>
- <para>
- Test if the dictionary contains a specified key
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.ReadOnlyPropertiesDictionary.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Serializes this object into the <see cref="T:System.Runtime.Serialization.SerializationInfo"/> provided.
- </summary>
- <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> to populate with data.</param>
- <param name="context">The destination for this serialization.</param>
- <remarks>
- <para>
- Serializes this object into the <see cref="T:System.Runtime.Serialization.SerializationInfo"/> provided.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.ReadOnlyPropertiesDictionary.System#Collections#IDictionary#GetEnumerator">
- <summary>
- See <see cref="M:System.Collections.IDictionary.GetEnumerator"/>
- </summary>
- </member>
- <member name="M:log4net.Util.ReadOnlyPropertiesDictionary.System#Collections#IDictionary#Remove(System.Object)">
- <summary>
- See <see cref="M:System.Collections.IDictionary.Remove(System.Object)"/>
- </summary>
- <param name="key"></param>
- </member>
- <member name="M:log4net.Util.ReadOnlyPropertiesDictionary.System#Collections#IDictionary#Contains(System.Object)">
- <summary>
- See <see cref="M:System.Collections.IDictionary.Contains(System.Object)"/>
- </summary>
- <param name="key"></param>
- <returns></returns>
- </member>
- <member name="M:log4net.Util.ReadOnlyPropertiesDictionary.Clear">
- <summary>
- Remove all properties from the properties collection
- </summary>
- </member>
- <member name="M:log4net.Util.ReadOnlyPropertiesDictionary.System#Collections#IDictionary#Add(System.Object,System.Object)">
- <summary>
- See <see cref="M:System.Collections.IDictionary.Add(System.Object,System.Object)"/>
- </summary>
- <param name="key"></param>
- <param name="value"></param>
- </member>
- <member name="M:log4net.Util.ReadOnlyPropertiesDictionary.System#Collections#ICollection#CopyTo(System.Array,System.Int32)">
- <summary>
- See <see cref="M:System.Collections.ICollection.CopyTo(System.Array,System.Int32)"/>
- </summary>
- <param name="array"></param>
- <param name="index"></param>
- </member>
- <member name="M:log4net.Util.ReadOnlyPropertiesDictionary.System#Collections#IEnumerable#GetEnumerator">
- <summary>
- See <see cref="M:System.Collections.IEnumerable.GetEnumerator"/>
- </summary>
- </member>
- <member name="P:log4net.Util.ReadOnlyPropertiesDictionary.Item(System.String)">
- <summary>
- Gets or sets the value of the property with the specified key.
- </summary>
- <value>
- The value of the property with the specified key.
- </value>
- <param name="key">The key of the property to get or set.</param>
- <remarks>
- <para>
- The property value will only be serialized if it is serializable.
- If it cannot be serialized it will be silently ignored if
- a serialization operation is performed.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Util.ReadOnlyPropertiesDictionary.InnerHashtable">
- <summary>
- The hashtable used to store the properties
- </summary>
- <value>
- The internal collection used to store the properties
- </value>
- <remarks>
- <para>
- The hashtable used to store the properties
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Util.ReadOnlyPropertiesDictionary.System#Collections#IDictionary#IsReadOnly">
- <summary>
- See <see cref="P:System.Collections.IDictionary.IsReadOnly"/>
- </summary>
- </member>
- <member name="P:log4net.Util.ReadOnlyPropertiesDictionary.System#Collections#IDictionary#Item(System.Object)">
- <summary>
- See <see cref="P:System.Collections.IDictionary.Item(System.Object)"/>
- </summary>
- </member>
- <member name="P:log4net.Util.ReadOnlyPropertiesDictionary.System#Collections#IDictionary#Values">
- <summary>
- See <see cref="P:System.Collections.IDictionary.Values"/>
- </summary>
- </member>
- <member name="P:log4net.Util.ReadOnlyPropertiesDictionary.System#Collections#IDictionary#Keys">
- <summary>
- See <see cref="P:System.Collections.IDictionary.Keys"/>
- </summary>
- </member>
- <member name="P:log4net.Util.ReadOnlyPropertiesDictionary.System#Collections#IDictionary#IsFixedSize">
- <summary>
- See <see cref="P:System.Collections.IDictionary.IsFixedSize"/>
- </summary>
- </member>
- <member name="P:log4net.Util.ReadOnlyPropertiesDictionary.System#Collections#ICollection#IsSynchronized">
- <summary>
- See <see cref="P:System.Collections.ICollection.IsSynchronized"/>
- </summary>
- </member>
- <member name="P:log4net.Util.ReadOnlyPropertiesDictionary.Count">
- <summary>
- The number of properties in this collection
- </summary>
- </member>
- <member name="P:log4net.Util.ReadOnlyPropertiesDictionary.System#Collections#ICollection#SyncRoot">
- <summary>
- See <see cref="P:System.Collections.ICollection.SyncRoot"/>
- </summary>
- </member>
- <member name="M:log4net.Util.PropertiesDictionary.#ctor">
- <summary>
- Constructor
- </summary>
- <remarks>
- <para>
- Initializes a new instance of the <see cref="T:log4net.Util.PropertiesDictionary"/> class.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.PropertiesDictionary.#ctor(log4net.Util.ReadOnlyPropertiesDictionary)">
- <summary>
- Constructor
- </summary>
- <param name="propertiesDictionary">properties to copy</param>
- <remarks>
- <para>
- Initializes a new instance of the <see cref="T:log4net.Util.PropertiesDictionary"/> class.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.PropertiesDictionary.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Initializes a new instance of the <see cref="T:log4net.Util.PropertiesDictionary"/> class
- with serialized data.
- </summary>
- <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data.</param>
- <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
- <remarks>
- <para>
- Because this class is sealed the serialization constructor is private.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.PropertiesDictionary.Remove(System.String)">
- <summary>
- Remove the entry with the specified key from this dictionary
- </summary>
- <param name="key">the key for the entry to remove</param>
- <remarks>
- <para>
- Remove the entry with the specified key from this dictionary
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.PropertiesDictionary.System#Collections#IDictionary#GetEnumerator">
- <summary>
- See <see cref="M:System.Collections.IDictionary.GetEnumerator"/>
- </summary>
- <returns>an enumerator</returns>
- <remarks>
- <para>
- Returns a <see cref="T:System.Collections.IDictionaryEnumerator"/> over the contest of this collection.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.PropertiesDictionary.System#Collections#IDictionary#Remove(System.Object)">
- <summary>
- See <see cref="M:System.Collections.IDictionary.Remove(System.Object)"/>
- </summary>
- <param name="key">the key to remove</param>
- <remarks>
- <para>
- Remove the entry with the specified key from this dictionary
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.PropertiesDictionary.System#Collections#IDictionary#Contains(System.Object)">
- <summary>
- See <see cref="M:System.Collections.IDictionary.Contains(System.Object)"/>
- </summary>
- <param name="key">the key to lookup in the collection</param>
- <returns><c>true</c> if the collection contains the specified key</returns>
- <remarks>
- <para>
- Test if this collection contains a specified key.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.PropertiesDictionary.Clear">
- <summary>
- Remove all properties from the properties collection
- </summary>
- <remarks>
- <para>
- Remove all properties from the properties collection
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.PropertiesDictionary.System#Collections#IDictionary#Add(System.Object,System.Object)">
- <summary>
- See <see cref="M:System.Collections.IDictionary.Add(System.Object,System.Object)"/>
- </summary>
- <param name="key">the key</param>
- <param name="value">the value to store for the key</param>
- <remarks>
- <para>
- Store a value for the specified <see cref="T:System.String"/> <paramref name="key"/>.
- </para>
- </remarks>
- <exception cref="T:System.ArgumentException">Thrown if the <paramref name="key"/> is not a string</exception>
- </member>
- <member name="M:log4net.Util.PropertiesDictionary.System#Collections#ICollection#CopyTo(System.Array,System.Int32)">
- <summary>
- See <see cref="M:System.Collections.ICollection.CopyTo(System.Array,System.Int32)"/>
- </summary>
- <param name="array"></param>
- <param name="index"></param>
- </member>
- <member name="M:log4net.Util.PropertiesDictionary.System#Collections#IEnumerable#GetEnumerator">
- <summary>
- See <see cref="M:System.Collections.IEnumerable.GetEnumerator"/>
- </summary>
- </member>
- <member name="P:log4net.Util.PropertiesDictionary.Item(System.String)">
- <summary>
- Gets or sets the value of the property with the specified key.
- </summary>
- <value>
- The value of the property with the specified key.
- </value>
- <param name="key">The key of the property to get or set.</param>
- <remarks>
- <para>
- The property value will only be serialized if it is serializable.
- If it cannot be serialized it will be silently ignored if
- a serialization operation is performed.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Util.PropertiesDictionary.System#Collections#IDictionary#IsReadOnly">
- <summary>
- See <see cref="P:System.Collections.IDictionary.IsReadOnly"/>
- </summary>
- <value>
- <c>false</c>
- </value>
- <remarks>
- <para>
- This collection is modifiable. This property always
- returns <c>false</c>.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Util.PropertiesDictionary.System#Collections#IDictionary#Item(System.Object)">
- <summary>
- See <see cref="P:System.Collections.IDictionary.Item(System.Object)"/>
- </summary>
- <value>
- The value for the key specified.
- </value>
- <remarks>
- <para>
- Get or set a value for the specified <see cref="T:System.String"/> <paramref name="key"/>.
- </para>
- </remarks>
- <exception cref="T:System.ArgumentException">Thrown if the <paramref name="key"/> is not a string</exception>
- </member>
- <member name="P:log4net.Util.PropertiesDictionary.System#Collections#IDictionary#Values">
- <summary>
- See <see cref="P:System.Collections.IDictionary.Values"/>
- </summary>
- </member>
- <member name="P:log4net.Util.PropertiesDictionary.System#Collections#IDictionary#Keys">
- <summary>
- See <see cref="P:System.Collections.IDictionary.Keys"/>
- </summary>
- </member>
- <member name="P:log4net.Util.PropertiesDictionary.System#Collections#IDictionary#IsFixedSize">
- <summary>
- See <see cref="P:System.Collections.IDictionary.IsFixedSize"/>
- </summary>
- </member>
- <member name="P:log4net.Util.PropertiesDictionary.System#Collections#ICollection#IsSynchronized">
- <summary>
- See <see cref="P:System.Collections.ICollection.IsSynchronized"/>
- </summary>
- </member>
- <member name="P:log4net.Util.PropertiesDictionary.System#Collections#ICollection#SyncRoot">
- <summary>
- See <see cref="P:System.Collections.ICollection.SyncRoot"/>
- </summary>
- </member>
- <member name="T:log4net.Util.PropertyEntry">
- <summary>
- A class to hold the key and data for a property set in the config file
- </summary>
- <remarks>
- <para>
- A class to hold the key and data for a property set in the config file
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.PropertyEntry.ToString">
- <summary>
- Override <c>Object.ToString</c> to return sensible debug info
- </summary>
- <returns>string info about this object</returns>
- </member>
- <member name="P:log4net.Util.PropertyEntry.Key">
- <summary>
- Property Key
- </summary>
- <value>
- Property Key
- </value>
- <remarks>
- <para>
- Property Key.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Util.PropertyEntry.Value">
- <summary>
- Property Value
- </summary>
- <value>
- Property Value
- </value>
- <remarks>
- <para>
- Property Value.
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Util.ProtectCloseTextWriter">
- <summary>
- A <see cref="T:System.IO.TextWriter"/> that ignores the <see cref="M:log4net.Util.ProtectCloseTextWriter.Close"/> message
- </summary>
- <remarks>
- <para>
- This writer is used in special cases where it is necessary
- to protect a writer from being closed by a client.
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- </member>
- <member name="M:log4net.Util.ProtectCloseTextWriter.#ctor(System.IO.TextWriter)">
- <summary>
- Constructor
- </summary>
- <param name="writer">the writer to actually write to</param>
- <remarks>
- <para>
- Create a new ProtectCloseTextWriter using a writer
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.ProtectCloseTextWriter.Attach(System.IO.TextWriter)">
- <summary>
- Attach this instance to a different underlying <see cref="T:System.IO.TextWriter"/>
- </summary>
- <param name="writer">the writer to attach to</param>
- <remarks>
- <para>
- Attach this instance to a different underlying <see cref="T:System.IO.TextWriter"/>
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.ProtectCloseTextWriter.Close">
- <summary>
- Does not close the underlying output writer.
- </summary>
- <remarks>
- <para>
- Does not close the underlying output writer.
- This method does nothing.
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Util.ReaderWriterLock">
- <summary>
- Defines a lock that supports single writers and multiple readers
- </summary>
- <remarks>
- <para>
- <c>ReaderWriterLock</c> is used to synchronize access to a resource.
- At any given time, it allows either concurrent read access for
- multiple threads, or write access for a single thread. In a
- situation where a resource is changed infrequently, a
- <c>ReaderWriterLock</c> provides better throughput than a simple
- one-at-a-time lock, such as <see cref="T:System.Threading.Monitor"/>.
- </para>
- <para>
- If a platform does not support a <c>System.Threading.ReaderWriterLock</c>
- implementation then all readers and writers are serialized. Therefore
- the caller must not rely on multiple simultaneous readers.
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- </member>
- <member name="M:log4net.Util.ReaderWriterLock.#ctor">
- <summary>
- Constructor
- </summary>
- <remarks>
- <para>
- Initializes a new instance of the <see cref="T:log4net.Util.ReaderWriterLock"/> class.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.ReaderWriterLock.AcquireReaderLock">
- <summary>
- Acquires a reader lock
- </summary>
- <remarks>
- <para>
- <see cref="M:log4net.Util.ReaderWriterLock.AcquireReaderLock"/> blocks if a different thread has the writer
- lock, or if at least one thread is waiting for the writer lock.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.ReaderWriterLock.ReleaseReaderLock">
- <summary>
- Decrements the lock count
- </summary>
- <remarks>
- <para>
- <see cref="M:log4net.Util.ReaderWriterLock.ReleaseReaderLock"/> decrements the lock count. When the count
- reaches zero, the lock is released.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.ReaderWriterLock.AcquireWriterLock">
- <summary>
- Acquires the writer lock
- </summary>
- <remarks>
- <para>
- This method blocks if another thread has a reader lock or writer lock.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.ReaderWriterLock.ReleaseWriterLock">
- <summary>
- Decrements the lock count on the writer lock
- </summary>
- <remarks>
- <para>
- ReleaseWriterLock decrements the writer lock count.
- When the count reaches zero, the writer lock is released.
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Util.ReusableStringWriter">
- <summary>
- A <see cref="T:System.IO.StringWriter"/> that can be <see cref="M:log4net.Util.ReusableStringWriter.Reset(System.Int32,System.Int32)"/> and reused
- </summary>
- <remarks>
- <para>
- A <see cref="T:System.IO.StringWriter"/> that can be <see cref="M:log4net.Util.ReusableStringWriter.Reset(System.Int32,System.Int32)"/> and reused.
- This uses a single buffer for string operations.
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- </member>
- <member name="M:log4net.Util.ReusableStringWriter.#ctor(System.IFormatProvider)">
- <summary>
- Create an instance of <see cref="T:log4net.Util.ReusableStringWriter"/>
- </summary>
- <param name="formatProvider">the format provider to use</param>
- <remarks>
- <para>
- Create an instance of <see cref="T:log4net.Util.ReusableStringWriter"/>
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.ReusableStringWriter.Dispose(System.Boolean)">
- <summary>
- Override Dispose to prevent closing of writer
- </summary>
- <param name="disposing">flag</param>
- <remarks>
- <para>
- Override Dispose to prevent closing of writer
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.ReusableStringWriter.Reset(System.Int32,System.Int32)">
- <summary>
- Reset this string writer so that it can be reused.
- </summary>
- <param name="maxCapacity">the maximum buffer capacity before it is trimmed</param>
- <param name="defaultSize">the default size to make the buffer</param>
- <remarks>
- <para>
- Reset this string writer so that it can be reused.
- The internal buffers are cleared and reset.
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Util.SystemInfo">
- <summary>
- Utility class for system specific information.
- </summary>
- <remarks>
- <para>
- Utility class of static methods for system specific information.
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- <author>Gert Driesen</author>
- <author>Alexey Solofnenko</author>
- </member>
- <member name="M:log4net.Util.SystemInfo.#ctor">
- <summary>
- Private constructor to prevent instances.
- </summary>
- <remarks>
- <para>
- Only static methods are exposed from this type.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.SystemInfo.#cctor">
- <summary>
- Initialize default values for private static fields.
- </summary>
- <remarks>
- <para>
- Only static methods are exposed from this type.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.SystemInfo.AssemblyLocationInfo(System.Reflection.Assembly)">
- <summary>
- Gets the assembly location path for the specified assembly.
- </summary>
- <param name="myAssembly">The assembly to get the location for.</param>
- <returns>The location of the assembly.</returns>
- <remarks>
- <para>
- This method does not guarantee to return the correct path
- to the assembly. If only tries to give an indication as to
- where the assembly was loaded from.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.SystemInfo.AssemblyQualifiedName(System.Type)">
- <summary>
- Gets the fully qualified name of the <see cref="T:System.Type"/>, including
- the name of the assembly from which the <see cref="T:System.Type"/> was
- loaded.
- </summary>
- <param name="type">The <see cref="T:System.Type"/> to get the fully qualified name for.</param>
- <returns>The fully qualified name for the <see cref="T:System.Type"/>.</returns>
- <remarks>
- <para>
- This is equivalent to the <c>Type.AssemblyQualifiedName</c> property,
- but this method works on the .NET Compact Framework 1.0 as well as
- the full .NET runtime.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.SystemInfo.AssemblyShortName(System.Reflection.Assembly)">
- <summary>
- Gets the short name of the <see cref="T:System.Reflection.Assembly"/>.
- </summary>
- <param name="myAssembly">The <see cref="T:System.Reflection.Assembly"/> to get the name for.</param>
- <returns>The short name of the <see cref="T:System.Reflection.Assembly"/>.</returns>
- <remarks>
- <para>
- The short name of the assembly is the <see cref="P:System.Reflection.Assembly.FullName"/>
- without the version, culture, or public key. i.e. it is just the
- assembly's file name without the extension.
- </para>
- <para>
- Use this rather than <c>Assembly.GetName().Name</c> because that
- is not available on the Compact Framework.
- </para>
- <para>
- Because of a FileIOPermission security demand we cannot do
- the obvious Assembly.GetName().Name. We are allowed to get
- the <see cref="P:System.Reflection.Assembly.FullName"/> of the assembly so we
- start from there and strip out just the assembly name.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.SystemInfo.AssemblyFileName(System.Reflection.Assembly)">
- <summary>
- Gets the file name portion of the <see cref="T:System.Reflection.Assembly"/>, including the extension.
- </summary>
- <param name="myAssembly">The <see cref="T:System.Reflection.Assembly"/> to get the file name for.</param>
- <returns>The file name of the assembly.</returns>
- <remarks>
- <para>
- Gets the file name portion of the <see cref="T:System.Reflection.Assembly"/>, including the extension.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.SystemInfo.GetTypeFromString(System.Type,System.String,System.Boolean,System.Boolean)">
- <summary>
- Loads the type specified in the type string.
- </summary>
- <param name="relativeType">A sibling type to use to load the type.</param>
- <param name="typeName">The name of the type to load.</param>
- <param name="throwOnError">Flag set to <c>true</c> to throw an exception if the type cannot be loaded.</param>
- <param name="ignoreCase"><c>true</c> to ignore the case of the type name; otherwise, <c>false</c></param>
- <returns>The type loaded or <c>null</c> if it could not be loaded.</returns>
- <remarks>
- <para>
- If the type name is fully qualified, i.e. if contains an assembly name in
- the type name, the type will be loaded from the system using
- <see cref="M:Type.GetType(string,bool)"/>.
- </para>
- <para>
- If the type name is not fully qualified, it will be loaded from the assembly
- containing the specified relative type. If the type is not found in the assembly
- then all the loaded assemblies will be searched for the type.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.SystemInfo.GetTypeFromString(System.String,System.Boolean,System.Boolean)">
- <summary>
- Loads the type specified in the type string.
- </summary>
- <param name="typeName">The name of the type to load.</param>
- <param name="throwOnError">Flag set to <c>true</c> to throw an exception if the type cannot be loaded.</param>
- <param name="ignoreCase"><c>true</c> to ignore the case of the type name; otherwise, <c>false</c></param>
- <returns>The type loaded or <c>null</c> if it could not be loaded.</returns>
- <remarks>
- <para>
- If the type name is fully qualified, i.e. if contains an assembly name in
- the type name, the type will be loaded from the system using
- <see cref="M:Type.GetType(string,bool)"/>.
- </para>
- <para>
- If the type name is not fully qualified it will be loaded from the
- assembly that is directly calling this method. If the type is not found
- in the assembly then all the loaded assemblies will be searched for the type.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.SystemInfo.GetTypeFromString(System.Reflection.Assembly,System.String,System.Boolean,System.Boolean)">
- <summary>
- Loads the type specified in the type string.
- </summary>
- <param name="relativeAssembly">An assembly to load the type from.</param>
- <param name="typeName">The name of the type to load.</param>
- <param name="throwOnError">Flag set to <c>true</c> to throw an exception if the type cannot be loaded.</param>
- <param name="ignoreCase"><c>true</c> to ignore the case of the type name; otherwise, <c>false</c></param>
- <returns>The type loaded or <c>null</c> if it could not be loaded.</returns>
- <remarks>
- <para>
- If the type name is fully qualified, i.e. if contains an assembly name in
- the type name, the type will be loaded from the system using
- <see cref="M:Type.GetType(string,bool)"/>.
- </para>
- <para>
- If the type name is not fully qualified it will be loaded from the specified
- assembly. If the type is not found in the assembly then all the loaded assemblies
- will be searched for the type.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.SystemInfo.NewGuid">
- <summary>
- Generate a new guid
- </summary>
- <returns>A new Guid</returns>
- <remarks>
- <para>
- Generate a new guid
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.SystemInfo.CreateArgumentOutOfRangeException(System.String,System.Object,System.String)">
- <summary>
- Create an <see cref="T:System.ArgumentOutOfRangeException"/>
- </summary>
- <param name="parameterName">The name of the parameter that caused the exception</param>
- <param name="actualValue">The value of the argument that causes this exception</param>
- <param name="message">The message that describes the error</param>
- <returns>the ArgumentOutOfRangeException object</returns>
- <remarks>
- <para>
- Create a new instance of the <see cref="T:System.ArgumentOutOfRangeException"/> class
- with a specified error message, the parameter name, and the value
- of the argument.
- </para>
- <para>
- The Compact Framework does not support the 3 parameter constructor for the
- <see cref="T:System.ArgumentOutOfRangeException"/> type. This method provides an
- implementation that works for all platforms.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.SystemInfo.TryParse(System.String,System.Int32@)">
- <summary>
- Parse a string into an <see cref="T:System.Int32"/> value
- </summary>
- <param name="s">the string to parse</param>
- <param name="val">out param where the parsed value is placed</param>
- <returns><c>true</c> if the string was able to be parsed into an integer</returns>
- <remarks>
- <para>
- Attempts to parse the string into an integer. If the string cannot
- be parsed then this method returns <c>false</c>. The method does not throw an exception.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.SystemInfo.TryParse(System.String,System.Int64@)">
- <summary>
- Parse a string into an <see cref="T:System.Int64"/> value
- </summary>
- <param name="s">the string to parse</param>
- <param name="val">out param where the parsed value is placed</param>
- <returns><c>true</c> if the string was able to be parsed into an integer</returns>
- <remarks>
- <para>
- Attempts to parse the string into an integer. If the string cannot
- be parsed then this method returns <c>false</c>. The method does not throw an exception.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.SystemInfo.TryParse(System.String,System.Int16@)">
- <summary>
- Parse a string into an <see cref="T:System.Int16"/> value
- </summary>
- <param name="s">the string to parse</param>
- <param name="val">out param where the parsed value is placed</param>
- <returns><c>true</c> if the string was able to be parsed into an integer</returns>
- <remarks>
- <para>
- Attempts to parse the string into an integer. If the string cannot
- be parsed then this method returns <c>false</c>. The method does not throw an exception.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.SystemInfo.GetAppSetting(System.String)">
- <summary>
- Lookup an application setting
- </summary>
- <param name="key">the application settings key to lookup</param>
- <returns>the value for the key, or <c>null</c></returns>
- <remarks>
- <para>
- Configuration APIs are not supported under the Compact Framework
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.SystemInfo.ConvertToFullPath(System.String)">
- <summary>
- Convert a path into a fully qualified local file path.
- </summary>
- <param name="path">The path to convert.</param>
- <returns>The fully qualified path.</returns>
- <remarks>
- <para>
- Converts the path specified to a fully
- qualified path. If the path is relative it is
- taken as relative from the application base
- directory.
- </para>
- <para>
- The path specified must be a local file path, a URI is not supported.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.SystemInfo.CreateCaseInsensitiveHashtable">
- <summary>
- Creates a new case-insensitive instance of the <see cref="T:System.Collections.Hashtable"/> class with the default initial capacity.
- </summary>
- <returns>A new case-insensitive instance of the <see cref="T:System.Collections.Hashtable"/> class with the default initial capacity</returns>
- <remarks>
- <para>
- The new Hashtable instance uses the default load factor, the CaseInsensitiveHashCodeProvider, and the CaseInsensitiveComparer.
- </para>
- </remarks>
- </member>
- <member name="F:log4net.Util.SystemInfo.EmptyTypes">
- <summary>
- Gets an empty array of types.
- </summary>
- <remarks>
- <para>
- The <c>Type.EmptyTypes</c> field is not available on
- the .NET Compact Framework 1.0.
- </para>
- </remarks>
- </member>
- <member name="F:log4net.Util.SystemInfo.declaringType">
- <summary>
- The fully qualified type of the SystemInfo class.
- </summary>
- <remarks>
- Used by the internal logger to record the Type of the
- log message.
- </remarks>
- </member>
- <member name="F:log4net.Util.SystemInfo.s_hostName">
- <summary>
- Cache the host name for the current machine
- </summary>
- </member>
- <member name="F:log4net.Util.SystemInfo.s_appFriendlyName">
- <summary>
- Cache the application friendly name
- </summary>
- </member>
- <member name="F:log4net.Util.SystemInfo.s_nullText">
- <summary>
- Text to output when a <c>null</c> is encountered.
- </summary>
- </member>
- <member name="F:log4net.Util.SystemInfo.s_notAvailableText">
- <summary>
- Text to output when an unsupported feature is requested.
- </summary>
- </member>
- <member name="F:log4net.Util.SystemInfo.s_processStartTime">
- <summary>
- Start time for the current process.
- </summary>
- </member>
- <member name="P:log4net.Util.SystemInfo.NewLine">
- <summary>
- Gets the system dependent line terminator.
- </summary>
- <value>
- The system dependent line terminator.
- </value>
- <remarks>
- <para>
- Gets the system dependent line terminator.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Util.SystemInfo.ApplicationBaseDirectory">
- <summary>
- Gets the base directory for this <see cref="T:System.AppDomain"/>.
- </summary>
- <value>The base directory path for the current <see cref="T:System.AppDomain"/>.</value>
- <remarks>
- <para>
- Gets the base directory for this <see cref="T:System.AppDomain"/>.
- </para>
- <para>
- The value returned may be either a local file path or a URI.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Util.SystemInfo.ConfigurationFileLocation">
- <summary>
- Gets the path to the configuration file for the current <see cref="T:System.AppDomain"/>.
- </summary>
- <value>The path to the configuration file for the current <see cref="T:System.AppDomain"/>.</value>
- <remarks>
- <para>
- The .NET Compact Framework 1.0 does not have a concept of a configuration
- file. For this runtime, we use the entry assembly location as the root for
- the configuration file name.
- </para>
- <para>
- The value returned may be either a local file path or a URI.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Util.SystemInfo.EntryAssemblyLocation">
- <summary>
- Gets the path to the file that first executed in the current <see cref="T:System.AppDomain"/>.
- </summary>
- <value>The path to the entry assembly.</value>
- <remarks>
- <para>
- Gets the path to the file that first executed in the current <see cref="T:System.AppDomain"/>.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Util.SystemInfo.CurrentThreadId">
- <summary>
- Gets the ID of the current thread.
- </summary>
- <value>The ID of the current thread.</value>
- <remarks>
- <para>
- On the .NET framework, the <c>AppDomain.GetCurrentThreadId</c> method
- is used to obtain the thread ID for the current thread. This is the
- operating system ID for the thread.
- </para>
- <para>
- On the .NET Compact Framework 1.0 it is not possible to get the
- operating system thread ID for the current thread. The native method
- <c>GetCurrentThreadId</c> is implemented inline in a header file
- and cannot be called.
- </para>
- <para>
- On the .NET Framework 2.0 the <c>Thread.ManagedThreadId</c> is used as this
- gives a stable id unrelated to the operating system thread ID which may
- change if the runtime is using fibers.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Util.SystemInfo.HostName">
- <summary>
- Get the host name or machine name for the current machine
- </summary>
- <value>
- The hostname or machine name
- </value>
- <remarks>
- <para>
- Get the host name or machine name for the current machine
- </para>
- <para>
- The host name (<see cref="M:System.Net.Dns.GetHostName"/>) or
- the machine name (<c>Environment.MachineName</c>) for
- the current machine, or if neither of these are available
- then <c>NOT AVAILABLE</c> is returned.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Util.SystemInfo.ApplicationFriendlyName">
- <summary>
- Get this application's friendly name
- </summary>
- <value>
- The friendly name of this application as a string
- </value>
- <remarks>
- <para>
- If available the name of the application is retrieved from
- the <c>AppDomain</c> using <c>AppDomain.CurrentDomain.FriendlyName</c>.
- </para>
- <para>
- Otherwise the file name of the entry assembly is used.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Util.SystemInfo.ProcessStartTime">
- <summary>
- Get the start time for the current process.
- </summary>
- <remarks>
- <para>
- This is the time at which the log4net library was loaded into the
- AppDomain. Due to reports of a hang in the call to <c>System.Diagnostics.Process.StartTime</c>
- this is not the start time for the current process.
- </para>
- <para>
- The log4net library should be loaded by an application early during its
- startup, therefore this start time should be a good approximation for
- the actual start time.
- </para>
- <para>
- Note that AppDomains may be loaded and unloaded within the
- same process without the process terminating, however this start time
- will be set per AppDomain.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Util.SystemInfo.NullText">
- <summary>
- Text to output when a <c>null</c> is encountered.
- </summary>
- <remarks>
- <para>
- Use this value to indicate a <c>null</c> has been encountered while
- outputting a string representation of an item.
- </para>
- <para>
- The default value is <c>(null)</c>. This value can be overridden by specifying
- a value for the <c>log4net.NullText</c> appSetting in the application's
- .config file.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Util.SystemInfo.NotAvailableText">
- <summary>
- Text to output when an unsupported feature is requested.
- </summary>
- <remarks>
- <para>
- Use this value when an unsupported feature is requested.
- </para>
- <para>
- The default value is <c>NOT AVAILABLE</c>. This value can be overridden by specifying
- a value for the <c>log4net.NotAvailableText</c> appSetting in the application's
- .config file.
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Util.SystemStringFormat">
- <summary>
- Utility class that represents a format string.
- </summary>
- <remarks>
- <para>
- Utility class that represents a format string.
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- </member>
- <member name="M:log4net.Util.SystemStringFormat.#ctor(System.IFormatProvider,System.String,System.Object[])">
- <summary>
- Initialise the <see cref="T:log4net.Util.SystemStringFormat"/>
- </summary>
- <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information.</param>
- <param name="format">A <see cref="T:System.String"/> containing zero or more format items.</param>
- <param name="args">An <see cref="T:System.Object"/> array containing zero or more objects to format.</param>
- </member>
- <member name="M:log4net.Util.SystemStringFormat.ToString">
- <summary>
- Format the string and arguments
- </summary>
- <returns>the formatted string</returns>
- </member>
- <member name="M:log4net.Util.SystemStringFormat.StringFormat(System.IFormatProvider,System.String,System.Object[])">
- <summary>
- Replaces the format item in a specified <see cref="T:System.String"/> with the text equivalent
- of the value of a corresponding <see cref="T:System.Object"/> instance in a specified array.
- A specified parameter supplies culture-specific formatting information.
- </summary>
- <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information.</param>
- <param name="format">A <see cref="T:System.String"/> containing zero or more format items.</param>
- <param name="args">An <see cref="T:System.Object"/> array containing zero or more objects to format.</param>
- <returns>
- A copy of format in which the format items have been replaced by the <see cref="T:System.String"/>
- equivalent of the corresponding instances of <see cref="T:System.Object"/> in args.
- </returns>
- <remarks>
- <para>
- This method does not throw exceptions. If an exception thrown while formatting the result the
- exception and arguments are returned in the result string.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.SystemStringFormat.StringFormatError(System.Exception,System.String,System.Object[])">
- <summary>
- Process an error during StringFormat
- </summary>
- </member>
- <member name="M:log4net.Util.SystemStringFormat.RenderArray(System.Array,System.Text.StringBuilder)">
- <summary>
- Dump the contents of an array into a string builder
- </summary>
- </member>
- <member name="M:log4net.Util.SystemStringFormat.RenderObject(System.Object,System.Text.StringBuilder)">
- <summary>
- Dump an object to a string
- </summary>
- </member>
- <member name="F:log4net.Util.SystemStringFormat.declaringType">
- <summary>
- The fully qualified type of the SystemStringFormat class.
- </summary>
- <remarks>
- Used by the internal logger to record the Type of the
- log message.
- </remarks>
- </member>
- <member name="T:log4net.Util.ThreadContextProperties">
- <summary>
- Implementation of Properties collection for the <see cref="T:log4net.ThreadContext"/>
- </summary>
- <remarks>
- <para>
- Class implements a collection of properties that is specific to each thread.
- The class is not synchronized as each thread has its own <see cref="T:log4net.Util.PropertiesDictionary"/>.
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- </member>
- <member name="F:log4net.Util.ThreadContextProperties._dictionary">
- <summary>
- Each thread will automatically have its instance.
- </summary>
- </member>
- <member name="M:log4net.Util.ThreadContextProperties.#ctor">
- <summary>
- Internal constructor
- </summary>
- <remarks>
- <para>
- Initializes a new instance of the <see cref="T:log4net.Util.ThreadContextProperties"/> class.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.ThreadContextProperties.Remove(System.String)">
- <summary>
- Remove a property
- </summary>
- <param name="key">the key for the entry to remove</param>
- <remarks>
- <para>
- Remove a property
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.ThreadContextProperties.GetKeys">
- <summary>
- Get the keys stored in the properties.
- </summary>
- <para>
- Gets the keys stored in the properties.
- </para>
- <returns>a set of the defined keys</returns>
- </member>
- <member name="M:log4net.Util.ThreadContextProperties.Clear">
- <summary>
- Clear all properties
- </summary>
- <remarks>
- <para>
- Clear all properties
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.ThreadContextProperties.GetProperties(System.Boolean)">
- <summary>
- Get the <c>PropertiesDictionary</c> for this thread.
- </summary>
- <param name="create">create the dictionary if it does not exist, otherwise return null if does not exist</param>
- <returns>the properties for this thread</returns>
- <remarks>
- <para>
- The collection returned is only to be used on the calling thread. If the
- caller needs to share the collection between different threads then the
- caller must clone the collection before doing so.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Util.ThreadContextProperties.Item(System.String)">
- <summary>
- Gets or sets the value of a property
- </summary>
- <value>
- The value for the property with the specified key
- </value>
- <remarks>
- <para>
- Gets or sets the value of a property
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Util.ThreadContextStack">
- <summary>
- Implementation of Stack for the <see cref="T:log4net.ThreadContext"/>
- </summary>
- <remarks>
- <para>
- Implementation of Stack for the <see cref="T:log4net.ThreadContext"/>
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- </member>
- <member name="F:log4net.Util.ThreadContextStack.m_stack">
- <summary>
- The stack store.
- </summary>
- </member>
- <member name="M:log4net.Util.ThreadContextStack.#ctor">
- <summary>
- Internal constructor
- </summary>
- <remarks>
- <para>
- Initializes a new instance of the <see cref="T:log4net.Util.ThreadContextStack"/> class.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.ThreadContextStack.Clear">
- <summary>
- Clears all the contextual information held in this stack.
- </summary>
- <remarks>
- <para>
- Clears all the contextual information held in this stack.
- Only call this if you think that this tread is being reused after
- a previous call execution which may not have completed correctly.
- You do not need to use this method if you always guarantee to call
- the <see cref="M:System.IDisposable.Dispose"/> method of the <see cref="T:System.IDisposable"/>
- returned from <see cref="M:log4net.Util.ThreadContextStack.Push(System.String)"/> even in exceptional circumstances,
- for example by using the <c>using(log4net.ThreadContext.Stacks["NDC"].Push("Stack_Message"))</c>
- syntax.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.ThreadContextStack.Pop">
- <summary>
- Removes the top context from this stack.
- </summary>
- <returns>The message in the context that was removed from the top of this stack.</returns>
- <remarks>
- <para>
- Remove the top context from this stack, and return
- it to the caller. If this stack is empty then an
- empty string (not <see langword="null"/>) is returned.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.ThreadContextStack.Push(System.String)">
- <summary>
- Pushes a new context message into this stack.
- </summary>
- <param name="message">The new context message.</param>
- <returns>
- An <see cref="T:System.IDisposable"/> that can be used to clean up the context stack.
- </returns>
- <remarks>
- <para>
- Pushes a new context onto this stack. An <see cref="T:System.IDisposable"/>
- is returned that can be used to clean up this stack. This
- can be easily combined with the <c>using</c> keyword to scope the
- context.
- </para>
- </remarks>
- <example>Simple example of using the <c>Push</c> method with the <c>using</c> keyword.
- <code lang="C#">
- using(log4net.ThreadContext.Stacks["NDC"].Push("Stack_Message"))
- {
- log.Warn("This should have an ThreadContext Stack message");
- }
- </code>
- </example>
- </member>
- <member name="M:log4net.Util.ThreadContextStack.GetFullMessage">
- <summary>
- Gets the current context information for this stack.
- </summary>
- <returns>The current context information.</returns>
- </member>
- <member name="M:log4net.Util.ThreadContextStack.ToString">
- <summary>
- Gets the current context information for this stack.
- </summary>
- <returns>Gets the current context information</returns>
- <remarks>
- <para>
- Gets the current context information for this stack.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.ThreadContextStack.log4net#Core#IFixingRequired#GetFixedObject">
- <summary>
- Get a portable version of this object
- </summary>
- <returns>the portable instance of this object</returns>
- <remarks>
- <para>
- Get a cross thread portable version of this object
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Util.ThreadContextStack.Count">
- <summary>
- The number of messages in the stack
- </summary>
- <value>
- The current number of messages in the stack
- </value>
- <remarks>
- <para>
- The current number of messages in the stack. That is
- the number of times <see cref="M:log4net.Util.ThreadContextStack.Push(System.String)"/> has been called
- minus the number of times <see cref="M:log4net.Util.ThreadContextStack.Pop"/> has been called.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Util.ThreadContextStack.InternalStack">
- <summary>
- Gets and sets the internal stack used by this <see cref="T:log4net.Util.ThreadContextStack"/>
- </summary>
- <value>The internal storage stack</value>
- <remarks>
- <para>
- This property is provided only to support backward compatability
- of the <see cref="T:log4net.NDC"/>. Tytpically the internal stack should not
- be modified.
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Util.ThreadContextStack.StackFrame">
- <summary>
- Inner class used to represent a single context frame in the stack.
- </summary>
- <remarks>
- <para>
- Inner class used to represent a single context frame in the stack.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.ThreadContextStack.StackFrame.#ctor(System.String,log4net.Util.ThreadContextStack.StackFrame)">
- <summary>
- Constructor
- </summary>
- <param name="message">The message for this context.</param>
- <param name="parent">The parent context in the chain.</param>
- <remarks>
- <para>
- Initializes a new instance of the <see cref="T:log4net.Util.ThreadContextStack.StackFrame"/> class
- with the specified message and parent context.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Util.ThreadContextStack.StackFrame.Message">
- <summary>
- Get the message.
- </summary>
- <value>The message.</value>
- <remarks>
- <para>
- Get the message.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Util.ThreadContextStack.StackFrame.FullMessage">
- <summary>
- Gets the full text of the context down to the root level.
- </summary>
- <value>
- The full text of the context down to the root level.
- </value>
- <remarks>
- <para>
- Gets the full text of the context down to the root level.
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Util.ThreadContextStack.AutoPopStackFrame">
- <summary>
- Struct returned from the <see cref="M:log4net.Util.ThreadContextStack.Push(System.String)"/> method.
- </summary>
- <remarks>
- <para>
- This struct implements the <see cref="T:System.IDisposable"/> and is designed to be used
- with the <see langword="using"/> pattern to remove the stack frame at the end of the scope.
- </para>
- </remarks>
- </member>
- <member name="F:log4net.Util.ThreadContextStack.AutoPopStackFrame.m_frameStack">
- <summary>
- The ThreadContextStack internal stack
- </summary>
- </member>
- <member name="F:log4net.Util.ThreadContextStack.AutoPopStackFrame.m_frameDepth">
- <summary>
- The depth to trim the stack to when this instance is disposed
- </summary>
- </member>
- <member name="M:log4net.Util.ThreadContextStack.AutoPopStackFrame.#ctor(System.Collections.Stack,System.Int32)">
- <summary>
- Constructor
- </summary>
- <param name="frameStack">The internal stack used by the ThreadContextStack.</param>
- <param name="frameDepth">The depth to return the stack to when this object is disposed.</param>
- <remarks>
- <para>
- Initializes a new instance of the <see cref="T:log4net.Util.ThreadContextStack.AutoPopStackFrame"/> class with
- the specified stack and return depth.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.ThreadContextStack.AutoPopStackFrame.Dispose">
- <summary>
- Returns the stack to the correct depth.
- </summary>
- <remarks>
- <para>
- Returns the stack to the correct depth.
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Util.ThreadContextStacks">
- <summary>
- Implementation of Stacks collection for the <see cref="T:log4net.ThreadContext"/>
- </summary>
- <remarks>
- <para>
- Implementation of Stacks collection for the <see cref="T:log4net.ThreadContext"/>
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- </member>
- <member name="M:log4net.Util.ThreadContextStacks.#ctor(log4net.Util.ContextPropertiesBase)">
- <summary>
- Internal constructor
- </summary>
- <remarks>
- <para>
- Initializes a new instance of the <see cref="T:log4net.Util.ThreadContextStacks"/> class.
- </para>
- </remarks>
- </member>
- <member name="F:log4net.Util.ThreadContextStacks.declaringType">
- <summary>
- The fully qualified type of the ThreadContextStacks class.
- </summary>
- <remarks>
- Used by the internal logger to record the Type of the
- log message.
- </remarks>
- </member>
- <member name="P:log4net.Util.ThreadContextStacks.Item(System.String)">
- <summary>
- Gets the named thread context stack
- </summary>
- <value>
- The named stack
- </value>
- <remarks>
- <para>
- Gets the named thread context stack
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Util.Transform">
- <summary>
- Utility class for transforming strings.
- </summary>
- <remarks>
- <para>
- Utility class for transforming strings.
- </para>
- </remarks>
- <author>Nicko Cadell</author>
- <author>Gert Driesen</author>
- </member>
- <member name="M:log4net.Util.Transform.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:log4net.Util.Transform"/> class.
- </summary>
- <remarks>
- <para>
- Uses a private access modifier to prevent instantiation of this class.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.Transform.WriteEscapedXmlString(System.Xml.XmlWriter,System.String,System.String)">
- <summary>
- Write a string to an <see cref="T:System.Xml.XmlWriter"/>
- </summary>
- <param name="writer">the writer to write to</param>
- <param name="textData">the string to write</param>
- <param name="invalidCharReplacement">The string to replace non XML compliant chars with</param>
- <remarks>
- <para>
- The test is escaped either using XML escape entities
- or using CDATA sections.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.Transform.MaskXmlInvalidCharacters(System.String,System.String)">
- <summary>
- Replace invalid XML characters in text string
- </summary>
- <param name="textData">the XML text input string</param>
- <param name="mask">the string to use in place of invalid characters</param>
- <returns>A string that does not contain invalid XML characters.</returns>
- <remarks>
- <para>
- Certain Unicode code points are not allowed in the XML InfoSet, for
- details see: <a href="http://www.w3.org/TR/REC-xml/#charsets">http://www.w3.org/TR/REC-xml/#charsets</a>.
- </para>
- <para>
- This method replaces any illegal characters in the input string
- with the mask string specified.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.Transform.CountSubstrings(System.String,System.String)">
- <summary>
- Count the number of times that the substring occurs in the text
- </summary>
- <param name="text">the text to search</param>
- <param name="substring">the substring to find</param>
- <returns>the number of times the substring occurs in the text</returns>
- <remarks>
- <para>
- The substring is assumed to be non repeating within itself.
- </para>
- </remarks>
- </member>
- <member name="F:log4net.Util.Transform.INVALIDCHARS">
- <summary>
- Characters illegal in XML 1.0
- </summary>
- </member>
- <member name="T:log4net.Util.WindowsSecurityContext">
- <summary>
- Impersonate a Windows Account
- </summary>
- <remarks>
- <para>
- This <see cref="T:log4net.Core.SecurityContext"/> impersonates a Windows account.
- </para>
- <para>
- How the impersonation is done depends on the value of <see cref="M:log4net.Util.WindowsSecurityContext.Impersonate(System.Object)"/>.
- This allows the context to either impersonate a set of user credentials specified
- using username, domain name and password or to revert to the process credentials.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.WindowsSecurityContext.#ctor">
- <summary>
- Default constructor
- </summary>
- <remarks>
- <para>
- Default constructor
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.WindowsSecurityContext.ActivateOptions">
- <summary>
- Initialize the SecurityContext based on the options set.
- </summary>
- <remarks>
- <para>
- This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
- activation scheme. The <see cref="M:log4net.Util.WindowsSecurityContext.ActivateOptions"/> method must
- be called on this object after the configuration properties have
- been set. Until <see cref="M:log4net.Util.WindowsSecurityContext.ActivateOptions"/> is called this
- object is in an undefined state and must not be used.
- </para>
- <para>
- If any of the configuration properties are modified then
- <see cref="M:log4net.Util.WindowsSecurityContext.ActivateOptions"/> must be called again.
- </para>
- <para>
- The security context will try to Logon the specified user account and
- capture a primary token for impersonation.
- </para>
- </remarks>
- <exception cref="T:System.ArgumentNullException">The required <see cref="P:log4net.Util.WindowsSecurityContext.UserName"/>,
- <see cref="P:log4net.Util.WindowsSecurityContext.DomainName"/> or <see cref="P:log4net.Util.WindowsSecurityContext.Password"/> properties were not specified.</exception>
- </member>
- <member name="M:log4net.Util.WindowsSecurityContext.Impersonate(System.Object)">
- <summary>
- Impersonate the Windows account specified by the <see cref="P:log4net.Util.WindowsSecurityContext.UserName"/> and <see cref="P:log4net.Util.WindowsSecurityContext.DomainName"/> properties.
- </summary>
- <param name="state">caller provided state</param>
- <returns>
- An <see cref="T:System.IDisposable"/> instance that will revoke the impersonation of this SecurityContext
- </returns>
- <remarks>
- <para>
- Depending on the <see cref="P:log4net.Util.WindowsSecurityContext.Credentials"/> property either
- impersonate a user using credentials supplied or revert
- to the process credentials.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.WindowsSecurityContext.LogonUser(System.String,System.String,System.String)">
- <summary>
- Create a <see cref="T:System.Security.Principal.WindowsIdentity"/> given the userName, domainName and password.
- </summary>
- <param name="userName">the user name</param>
- <param name="domainName">the domain name</param>
- <param name="password">the password</param>
- <returns>the <see cref="T:System.Security.Principal.WindowsIdentity"/> for the account specified</returns>
- <remarks>
- <para>
- Uses the Windows API call LogonUser to get a principal token for the account. This
- token is used to initialize the WindowsIdentity.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Util.WindowsSecurityContext.Credentials">
- <summary>
- Gets or sets the impersonation mode for this security context
- </summary>
- <value>
- The impersonation mode for this security context
- </value>
- <remarks>
- <para>
- Impersonate either a user with user credentials or
- revert this thread to the credentials of the process.
- The value is one of the <see cref="T:log4net.Util.WindowsSecurityContext.ImpersonationMode"/>
- enum.
- </para>
- <para>
- The default value is <see cref="F:log4net.Util.WindowsSecurityContext.ImpersonationMode.User"/>
- </para>
- <para>
- When the mode is set to <see cref="F:log4net.Util.WindowsSecurityContext.ImpersonationMode.User"/>
- the user's credentials are established using the
- <see cref="P:log4net.Util.WindowsSecurityContext.UserName"/>, <see cref="P:log4net.Util.WindowsSecurityContext.DomainName"/> and <see cref="P:log4net.Util.WindowsSecurityContext.Password"/>
- values.
- </para>
- <para>
- When the mode is set to <see cref="F:log4net.Util.WindowsSecurityContext.ImpersonationMode.Process"/>
- no other properties need to be set. If the calling thread is
- impersonating then it will be reverted back to the process credentials.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Util.WindowsSecurityContext.UserName">
- <summary>
- Gets or sets the Windows username for this security context
- </summary>
- <value>
- The Windows username for this security context
- </value>
- <remarks>
- <para>
- This property must be set if <see cref="P:log4net.Util.WindowsSecurityContext.Credentials"/>
- is set to <see cref="F:log4net.Util.WindowsSecurityContext.ImpersonationMode.User"/> (the default setting).
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Util.WindowsSecurityContext.DomainName">
- <summary>
- Gets or sets the Windows domain name for this security context
- </summary>
- <value>
- The Windows domain name for this security context
- </value>
- <remarks>
- <para>
- The default value for <see cref="P:log4net.Util.WindowsSecurityContext.DomainName"/> is the local machine name
- taken from the <see cref="P:System.Environment.MachineName"/> property.
- </para>
- <para>
- This property must be set if <see cref="P:log4net.Util.WindowsSecurityContext.Credentials"/>
- is set to <see cref="F:log4net.Util.WindowsSecurityContext.ImpersonationMode.User"/> (the default setting).
- </para>
- </remarks>
- </member>
- <member name="P:log4net.Util.WindowsSecurityContext.Password">
- <summary>
- Sets the password for the Windows account specified by the <see cref="P:log4net.Util.WindowsSecurityContext.UserName"/> and <see cref="P:log4net.Util.WindowsSecurityContext.DomainName"/> properties.
- </summary>
- <value>
- The password for the Windows account specified by the <see cref="P:log4net.Util.WindowsSecurityContext.UserName"/> and <see cref="P:log4net.Util.WindowsSecurityContext.DomainName"/> properties.
- </value>
- <remarks>
- <para>
- This property must be set if <see cref="P:log4net.Util.WindowsSecurityContext.Credentials"/>
- is set to <see cref="F:log4net.Util.WindowsSecurityContext.ImpersonationMode.User"/> (the default setting).
- </para>
- </remarks>
- </member>
- <member name="T:log4net.Util.WindowsSecurityContext.ImpersonationMode">
- <summary>
- The impersonation modes for the <see cref="T:log4net.Util.WindowsSecurityContext"/>
- </summary>
- <remarks>
- <para>
- See the <see cref="P:log4net.Util.WindowsSecurityContext.Credentials"/> property for
- details.
- </para>
- </remarks>
- </member>
- <member name="F:log4net.Util.WindowsSecurityContext.ImpersonationMode.User">
- <summary>
- Impersonate a user using the credentials supplied
- </summary>
- </member>
- <member name="F:log4net.Util.WindowsSecurityContext.ImpersonationMode.Process">
- <summary>
- Revert this the thread to the credentials of the process
- </summary>
- </member>
- <member name="T:log4net.Util.WindowsSecurityContext.DisposableImpersonationContext">
- <summary>
- Adds <see cref="T:System.IDisposable"/> to <see cref="T:System.Security.Principal.WindowsImpersonationContext"/>
- </summary>
- <remarks>
- <para>
- Helper class to expose the <see cref="T:System.Security.Principal.WindowsImpersonationContext"/>
- through the <see cref="T:System.IDisposable"/> interface.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.WindowsSecurityContext.DisposableImpersonationContext.#ctor(System.Security.Principal.WindowsImpersonationContext)">
- <summary>
- Constructor
- </summary>
- <param name="impersonationContext">the impersonation context being wrapped</param>
- <remarks>
- <para>
- Constructor
- </para>
- </remarks>
- </member>
- <member name="M:log4net.Util.WindowsSecurityContext.DisposableImpersonationContext.Dispose">
- <summary>
- Revert the impersonation
- </summary>
- <remarks>
- <para>
- Revert the impersonation
- </para>
- </remarks>
- </member>
- <member name="T:log4net.GlobalContext">
- <summary>
- The log4net Global Context.
- </summary>
- <remarks>
- <para>
- The <c>GlobalContext</c> provides a location for global debugging
- information to be stored.
- </para>
- <para>
- The global context has a properties map and these properties can
- be included in the output of log messages. The <see cref="T:log4net.Layout.PatternLayout"/>
- supports selecting and outputing these properties.
- </para>
- <para>
- By default the <c>log4net:HostName</c> property is set to the name of
- the current machine.
- </para>
- </remarks>
- <example>
- <code lang="C#">
- GlobalContext.Properties["hostname"] = Environment.MachineName;
- </code>
- </example>
- <threadsafety static="true" instance="true"/>
- <author>Nicko Cadell</author>
- </member>
- <member name="M:log4net.GlobalContext.#ctor">
- <summary>
- Private Constructor.
- </summary>
- <remarks>
- Uses a private access modifier to prevent instantiation of this class.
- </remarks>
- </member>
- <member name="F:log4net.GlobalContext.s_properties">
- <summary>
- The global context properties instance
- </summary>
- </member>
- <member name="P:log4net.GlobalContext.Properties">
- <summary>
- The global properties map.
- </summary>
- <value>
- The global properties map.
- </value>
- <remarks>
- <para>
- The global properties map.
- </para>
- </remarks>
- </member>
- <member name="T:log4net.AssemblyInfo">
- <summary>
- Provides information about the environment the assembly has
- been built for.
- </summary>
- </member>
- <member name="F:log4net.AssemblyInfo.Version">
- <summary>Version of the assembly</summary>
- </member>
- <member name="F:log4net.AssemblyInfo.TargetFrameworkVersion">
- <summary>Version of the framework targeted</summary>
- </member>
- <member name="F:log4net.AssemblyInfo.TargetFramework">
- <summary>Type of framework targeted</summary>
- </member>
- <member name="F:log4net.AssemblyInfo.ClientProfile">
- <summary>Does it target a client profile?</summary>
- </member>
- <member name="P:log4net.AssemblyInfo.Info">
- <summary>
- Identifies the version and target for this assembly.
- </summary>
- </member>
- <member name="T:log4net.LogicalThreadContext">
- <summary>
- The log4net Logical Thread Context.
- </summary>
- <remarks>
- <para>
- The <c>LogicalThreadContext</c> provides a location for <see cref="T:System.Runtime.Remoting.Messaging.CallContext"/> specific debugging
- information to be stored.
- The <c>LogicalThreadContext</c> properties override any <see cref="T:log4net.ThreadContext"/> or <see cref="T:log4net.GlobalContext"/>
- properties with the same name.
- </para>
- <para>
- The Logical Thread Context has a properties map and a stack.
- The properties and stack can
- be included in the output of log messages. The <see cref="T:log4net.Layout.PatternLayout"/>
- supports selecting and outputting these properties.
- </para>
- <para>
- The Logical Thread Context provides a diagnostic context for the current call context.
- This is an instrument for distinguishing interleaved log
- output from different sources. Log output is typically interleaved
- when a server handles multiple clients near-simultaneously.
- </para>
- <para>
- The Logical Thread Context is managed on a per <see cref="T:System.Runtime.Remoting.Messaging.CallContext"/> basis.
- </para>
- <para>
- The <see cref="T:System.Runtime.Remoting.Messaging.CallContext"/> requires a link time
- <see cref="T:System.Security.Permissions.SecurityPermission"/> for the
- <see cref="F:System.Security.Permissions.SecurityPermissionFlag.Infrastructure"/>.
- If the calling code does not have this permission then this context will be disabled.
- It will not store any property values set on it.
- </para>
- </remarks>
- <example>Example of using the thread context properties to store a username.
- <code lang="C#">
- LogicalThreadContext.Properties["user"] = userName;
- log.Info("This log message has a LogicalThreadContext Property called 'user'");
- </code>
- </example>
- <example>Example of how to push a message into the context stack
- <code lang="C#">
- using(LogicalThreadContext.Stacks["LDC"].Push("my context message"))
- {
- log.Info("This log message has a LogicalThreadContext Stack message that includes 'my context message'");
-
- } // at the end of the using block the message is automatically popped
- </code>
- </example>
- <threadsafety static="true" instance="true"/>
- <author>Nicko Cadell</author>
- </member>
- <member name="M:log4net.LogicalThreadContext.#ctor">
- <summary>
- Private Constructor.
- </summary>
- <remarks>
- <para>
- Uses a private access modifier to prevent instantiation of this class.
- </para>
- </remarks>
- </member>
- <member name="F:log4net.LogicalThreadContext.s_properties">
- <summary>
- The thread context properties instance
- </summary>
- </member>
- <member name="F:log4net.LogicalThreadContext.s_stacks">
- <summary>
- The thread context stacks instance
- </summary>
- </member>
- <member name="P:log4net.LogicalThreadContext.Properties">
- <summary>
- The thread properties map
- </summary>
- <value>
- The thread properties map
- </value>
- <remarks>
- <para>
- The <c>LogicalThreadContext</c> properties override any <see cref="T:log4net.ThreadContext"/>
- or <see cref="T:log4net.GlobalContext"/> properties with the same name.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.LogicalThreadContext.Stacks">
- <summary>
- The thread stacks
- </summary>
- <value>
- stack map
- </value>
- <remarks>
- <para>
- The logical thread stacks.
- </para>
- </remarks>
- </member>
- <member name="T:log4net.LogManager">
- <summary>
- This class is used by client applications to request logger instances.
- </summary>
- <remarks>
- <para>
- This class has static methods that are used by a client to request
- a logger instance. The <see cref="M:GetLogger(string)"/> method is
- used to retrieve a logger.
- </para>
- <para>
- See the <see cref="T:log4net.ILog"/> interface for more details.
- </para>
- </remarks>
- <example>Simple example of logging messages
- <code lang="C#">
- ILog log = LogManager.GetLogger("application-log");
-
- log.Info("Application Start");
- log.Debug("This is a debug message");
-
- if (log.IsDebugEnabled)
- {
- log.Debug("This is another debug message");
- }
- </code>
- </example>
- <threadsafety static="true" instance="true"/>
- <seealso cref="T:log4net.ILog"/>
- <author>Nicko Cadell</author>
- <author>Gert Driesen</author>
- </member>
- <member name="M:log4net.LogManager.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:log4net.LogManager"/> class.
- </summary>
- <remarks>
- Uses a private access modifier to prevent instantiation of this class.
- </remarks>
- </member>
- <member name="M:log4net.LogManager.Exists(System.String)">
- <overloads>Returns the named logger if it exists.</overloads>
- <summary>
- Returns the named logger if it exists.
- </summary>
- <remarks>
- <para>
- If the named logger exists (in the default repository) then it
- returns a reference to the logger, otherwise it returns <c>null</c>.
- </para>
- </remarks>
- <param name="name">The fully qualified logger name to look for.</param>
- <returns>The logger found, or <c>null</c> if no logger could be found.</returns>
- </member>
- <member name="M:log4net.LogManager.Exists(System.String,System.String)">
- <summary>
- Returns the named logger if it exists.
- </summary>
- <remarks>
- <para>
- If the named logger exists (in the specified repository) then it
- returns a reference to the logger, otherwise it returns
- <c>null</c>.
- </para>
- </remarks>
- <param name="repository">The repository to lookup in.</param>
- <param name="name">The fully qualified logger name to look for.</param>
- <returns>
- The logger found, or <c>null</c> if the logger doesn't exist in the specified
- repository.
- </returns>
- </member>
- <member name="M:log4net.LogManager.Exists(System.Reflection.Assembly,System.String)">
- <summary>
- Returns the named logger if it exists.
- </summary>
- <remarks>
- <para>
- If the named logger exists (in the repository for the specified assembly) then it
- returns a reference to the logger, otherwise it returns
- <c>null</c>.
- </para>
- </remarks>
- <param name="repositoryAssembly">The assembly to use to lookup the repository.</param>
- <param name="name">The fully qualified logger name to look for.</param>
- <returns>
- The logger, or <c>null</c> if the logger doesn't exist in the specified
- assembly's repository.
- </returns>
- </member>
- <member name="M:log4net.LogManager.GetCurrentLoggers">
- <overloads>Get the currently defined loggers.</overloads>
- <summary>
- Returns all the currently defined loggers in the default repository.
- </summary>
- <remarks>
- <para>The root logger is <b>not</b> included in the returned array.</para>
- </remarks>
- <returns>All the defined loggers.</returns>
- </member>
- <member name="M:log4net.LogManager.GetCurrentLoggers(System.String)">
- <summary>
- Returns all the currently defined loggers in the specified repository.
- </summary>
- <param name="repository">The repository to lookup in.</param>
- <remarks>
- The root logger is <b>not</b> included in the returned array.
- </remarks>
- <returns>All the defined loggers.</returns>
- </member>
- <member name="M:log4net.LogManager.GetCurrentLoggers(System.Reflection.Assembly)">
- <summary>
- Returns all the currently defined loggers in the specified assembly's repository.
- </summary>
- <param name="repositoryAssembly">The assembly to use to lookup the repository.</param>
- <remarks>
- The root logger is <b>not</b> included in the returned array.
- </remarks>
- <returns>All the defined loggers.</returns>
- </member>
- <member name="M:log4net.LogManager.GetLogger(System.String)">
- <overloads>Get or create a logger.</overloads>
- <summary>
- Retrieves or creates a named logger.
- </summary>
- <remarks>
- <para>
- Retrieves a logger named as the <paramref name="name"/>
- parameter. If the named logger already exists, then the
- existing instance will be returned. Otherwise, a new instance is
- created.
- </para>
- <para>By default, loggers do not have a set level but inherit
- it from the hierarchy. This is one of the central features of
- log4net.
- </para>
- </remarks>
- <param name="name">The name of the logger to retrieve.</param>
- <returns>The logger with the name specified.</returns>
- </member>
- <member name="M:log4net.LogManager.GetLogger(System.String,System.String)">
- <summary>
- Retrieves or creates a named logger.
- </summary>
- <remarks>
- <para>
- Retrieve a logger named as the <paramref name="name"/>
- parameter. If the named logger already exists, then the
- existing instance will be returned. Otherwise, a new instance is
- created.
- </para>
- <para>
- By default, loggers do not have a set level but inherit
- it from the hierarchy. This is one of the central features of
- log4net.
- </para>
- </remarks>
- <param name="repository">The repository to lookup in.</param>
- <param name="name">The name of the logger to retrieve.</param>
- <returns>The logger with the name specified.</returns>
- </member>
- <member name="M:log4net.LogManager.GetLogger(System.Reflection.Assembly,System.String)">
- <summary>
- Retrieves or creates a named logger.
- </summary>
- <remarks>
- <para>
- Retrieve a logger named as the <paramref name="name"/>
- parameter. If the named logger already exists, then the
- existing instance will be returned. Otherwise, a new instance is
- created.
- </para>
- <para>
- By default, loggers do not have a set level but inherit
- it from the hierarchy. This is one of the central features of
- log4net.
- </para>
- </remarks>
- <param name="repositoryAssembly">The assembly to use to lookup the repository.</param>
- <param name="name">The name of the logger to retrieve.</param>
- <returns>The logger with the name specified.</returns>
- </member>
- <member name="M:log4net.LogManager.GetLogger(System.Type)">
- <summary>
- Shorthand for <see cref="M:LogManager.GetLogger(string)"/>.
- </summary>
- <remarks>
- Get the logger for the fully qualified name of the type specified.
- </remarks>
- <param name="type">The full name of <paramref name="type"/> will be used as the name of the logger to retrieve.</param>
- <returns>The logger with the name specified.</returns>
- </member>
- <member name="M:log4net.LogManager.GetLogger(System.String,System.Type)">
- <summary>
- Shorthand for <see cref="M:LogManager.GetLogger(string)"/>.
- </summary>
- <remarks>
- Gets the logger for the fully qualified name of the type specified.
- </remarks>
- <param name="repository">The repository to lookup in.</param>
- <param name="type">The full name of <paramref name="type"/> will be used as the name of the logger to retrieve.</param>
- <returns>The logger with the name specified.</returns>
- </member>
- <member name="M:log4net.LogManager.GetLogger(System.Reflection.Assembly,System.Type)">
- <summary>
- Shorthand for <see cref="M:LogManager.GetLogger(string)"/>.
- </summary>
- <remarks>
- Gets the logger for the fully qualified name of the type specified.
- </remarks>
- <param name="repositoryAssembly">The assembly to use to lookup the repository.</param>
- <param name="type">The full name of <paramref name="type"/> will be used as the name of the logger to retrieve.</param>
- <returns>The logger with the name specified.</returns>
- </member>
- <member name="M:log4net.LogManager.Shutdown">
- <summary>
- Shuts down the log4net system.
- </summary>
- <remarks>
- <para>
- Calling this method will <b>safely</b> close and remove all
- appenders in all the loggers including root contained in all the
- default repositories.
- </para>
- <para>
- Some appenders need to be closed before the application exists.
- Otherwise, pending logging events might be lost.
- </para>
- <para>The <c>shutdown</c> method is careful to close nested
- appenders before closing regular appenders. This is allows
- configurations where a regular appender is attached to a logger
- and again to a nested appender.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.LogManager.ShutdownRepository">
- <overloads>Shutdown a logger repository.</overloads>
- <summary>
- Shuts down the default repository.
- </summary>
- <remarks>
- <para>
- Calling this method will <b>safely</b> close and remove all
- appenders in all the loggers including root contained in the
- default repository.
- </para>
- <para>Some appenders need to be closed before the application exists.
- Otherwise, pending logging events might be lost.
- </para>
- <para>The <c>shutdown</c> method is careful to close nested
- appenders before closing regular appenders. This is allows
- configurations where a regular appender is attached to a logger
- and again to a nested appender.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.LogManager.ShutdownRepository(System.String)">
- <summary>
- Shuts down the repository for the repository specified.
- </summary>
- <remarks>
- <para>
- Calling this method will <b>safely</b> close and remove all
- appenders in all the loggers including root contained in the
- <paramref name="repository"/> specified.
- </para>
- <para>
- Some appenders need to be closed before the application exists.
- Otherwise, pending logging events might be lost.
- </para>
- <para>The <c>shutdown</c> method is careful to close nested
- appenders before closing regular appenders. This is allows
- configurations where a regular appender is attached to a logger
- and again to a nested appender.
- </para>
- </remarks>
- <param name="repository">The repository to shutdown.</param>
- </member>
- <member name="M:log4net.LogManager.ShutdownRepository(System.Reflection.Assembly)">
- <summary>
- Shuts down the repository specified.
- </summary>
- <remarks>
- <para>
- Calling this method will <b>safely</b> close and remove all
- appenders in all the loggers including root contained in the
- repository. The repository is looked up using
- the <paramref name="repositoryAssembly"/> specified.
- </para>
- <para>
- Some appenders need to be closed before the application exists.
- Otherwise, pending logging events might be lost.
- </para>
- <para>
- The <c>shutdown</c> method is careful to close nested
- appenders before closing regular appenders. This is allows
- configurations where a regular appender is attached to a logger
- and again to a nested appender.
- </para>
- </remarks>
- <param name="repositoryAssembly">The assembly to use to lookup the repository.</param>
- </member>
- <member name="M:log4net.LogManager.ResetConfiguration">
- <overloads>Reset the configuration of a repository</overloads>
- <summary>
- Resets all values contained in this repository instance to their defaults.
- </summary>
- <remarks>
- <para>
- Resets all values contained in the repository instance to their
- defaults. This removes all appenders from all loggers, sets
- the level of all non-root loggers to <c>null</c>,
- sets their additivity flag to <c>true</c> and sets the level
- of the root logger to <see cref="F:log4net.Core.Level.Debug"/>. Moreover,
- message disabling is set to its default "off" value.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.LogManager.ResetConfiguration(System.String)">
- <summary>
- Resets all values contained in this repository instance to their defaults.
- </summary>
- <remarks>
- <para>
- Reset all values contained in the repository instance to their
- defaults. This removes all appenders from all loggers, sets
- the level of all non-root loggers to <c>null</c>,
- sets their additivity flag to <c>true</c> and sets the level
- of the root logger to <see cref="F:log4net.Core.Level.Debug"/>. Moreover,
- message disabling is set to its default "off" value.
- </para>
- </remarks>
- <param name="repository">The repository to reset.</param>
- </member>
- <member name="M:log4net.LogManager.ResetConfiguration(System.Reflection.Assembly)">
- <summary>
- Resets all values contained in this repository instance to their defaults.
- </summary>
- <remarks>
- <para>
- Reset all values contained in the repository instance to their
- defaults. This removes all appenders from all loggers, sets
- the level of all non-root loggers to <c>null</c>,
- sets their additivity flag to <c>true</c> and sets the level
- of the root logger to <see cref="F:log4net.Core.Level.Debug"/>. Moreover,
- message disabling is set to its default "off" value.
- </para>
- </remarks>
- <param name="repositoryAssembly">The assembly to use to lookup the repository to reset.</param>
- </member>
- <member name="M:log4net.LogManager.GetLoggerRepository">
- <overloads>Get the logger repository.</overloads>
- <summary>
- Returns the default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.
- </summary>
- <remarks>
- <para>
- Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified
- by the callers assembly (<see cref="M:Assembly.GetCallingAssembly()"/>).
- </para>
- </remarks>
- <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> instance for the default repository.</returns>
- </member>
- <member name="M:log4net.LogManager.GetLoggerRepository(System.String)">
- <summary>
- Returns the default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.
- </summary>
- <returns>The default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.</returns>
- <remarks>
- <para>
- Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified
- by the <paramref name="repository"/> argument.
- </para>
- </remarks>
- <param name="repository">The repository to lookup in.</param>
- </member>
- <member name="M:log4net.LogManager.GetLoggerRepository(System.Reflection.Assembly)">
- <summary>
- Returns the default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.
- </summary>
- <returns>The default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.</returns>
- <remarks>
- <para>
- Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified
- by the <paramref name="repositoryAssembly"/> argument.
- </para>
- </remarks>
- <param name="repositoryAssembly">The assembly to use to lookup the repository.</param>
- </member>
- <member name="M:log4net.LogManager.GetRepository">
- <overloads>Get a logger repository.</overloads>
- <summary>
- Returns the default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.
- </summary>
- <remarks>
- <para>
- Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified
- by the callers assembly (<see cref="M:Assembly.GetCallingAssembly()"/>).
- </para>
- </remarks>
- <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> instance for the default repository.</returns>
- </member>
- <member name="M:log4net.LogManager.GetRepository(System.String)">
- <summary>
- Returns the default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.
- </summary>
- <returns>The default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.</returns>
- <remarks>
- <para>
- Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified
- by the <paramref name="repository"/> argument.
- </para>
- </remarks>
- <param name="repository">The repository to lookup in.</param>
- </member>
- <member name="M:log4net.LogManager.GetRepository(System.Reflection.Assembly)">
- <summary>
- Returns the default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.
- </summary>
- <returns>The default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.</returns>
- <remarks>
- <para>
- Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified
- by the <paramref name="repositoryAssembly"/> argument.
- </para>
- </remarks>
- <param name="repositoryAssembly">The assembly to use to lookup the repository.</param>
- </member>
- <member name="M:log4net.LogManager.CreateDomain(System.Type)">
- <overloads>Create a domain</overloads>
- <summary>
- Creates a repository with the specified repository type.
- </summary>
- <remarks>
- <para>
- <b>CreateDomain is obsolete. Use CreateRepository instead of CreateDomain.</b>
- </para>
- <para>
- The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be associated with the repository
- specified such that a call to <see cref="M:GetRepository()"/> will return
- the same repository instance.
- </para>
- </remarks>
- <param name="repositoryType">A <see cref="T:System.Type"/> that implements <see cref="T:log4net.Repository.ILoggerRepository"/>
- and has a no arg constructor. An instance of this type will be created to act
- as the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified.</param>
- <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> created for the repository.</returns>
- </member>
- <member name="M:log4net.LogManager.CreateRepository(System.Type)">
- <overloads>Create a logger repository.</overloads>
- <summary>
- Creates a repository with the specified repository type.
- </summary>
- <param name="repositoryType">A <see cref="T:System.Type"/> that implements <see cref="T:log4net.Repository.ILoggerRepository"/>
- and has a no arg constructor. An instance of this type will be created to act
- as the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified.</param>
- <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> created for the repository.</returns>
- <remarks>
- <para>
- The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be associated with the repository
- specified such that a call to <see cref="M:GetRepository()"/> will return
- the same repository instance.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.LogManager.CreateDomain(System.String)">
- <summary>
- Creates a repository with the specified name.
- </summary>
- <remarks>
- <para>
- <b>CreateDomain is obsolete. Use CreateRepository instead of CreateDomain.</b>
- </para>
- <para>
- Creates the default type of <see cref="T:log4net.Repository.ILoggerRepository"/> which is a
- <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/> object.
- </para>
- <para>
- The <paramref name="repository"/> name must be unique. Repositories cannot be redefined.
- An <see cref="T:System.Exception"/> will be thrown if the repository already exists.
- </para>
- </remarks>
- <param name="repository">The name of the repository, this must be unique amongst repositories.</param>
- <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> created for the repository.</returns>
- <exception cref="T:log4net.Core.LogException">The specified repository already exists.</exception>
- </member>
- <member name="M:log4net.LogManager.CreateRepository(System.String)">
- <summary>
- Creates a repository with the specified name.
- </summary>
- <remarks>
- <para>
- Creates the default type of <see cref="T:log4net.Repository.ILoggerRepository"/> which is a
- <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/> object.
- </para>
- <para>
- The <paramref name="repository"/> name must be unique. Repositories cannot be redefined.
- An <see cref="T:System.Exception"/> will be thrown if the repository already exists.
- </para>
- </remarks>
- <param name="repository">The name of the repository, this must be unique amongst repositories.</param>
- <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> created for the repository.</returns>
- <exception cref="T:log4net.Core.LogException">The specified repository already exists.</exception>
- </member>
- <member name="M:log4net.LogManager.CreateDomain(System.String,System.Type)">
- <summary>
- Creates a repository with the specified name and repository type.
- </summary>
- <remarks>
- <para>
- <b>CreateDomain is obsolete. Use CreateRepository instead of CreateDomain.</b>
- </para>
- <para>
- The <paramref name="repository"/> name must be unique. Repositories cannot be redefined.
- An <see cref="T:System.Exception"/> will be thrown if the repository already exists.
- </para>
- </remarks>
- <param name="repository">The name of the repository, this must be unique to the repository.</param>
- <param name="repositoryType">A <see cref="T:System.Type"/> that implements <see cref="T:log4net.Repository.ILoggerRepository"/>
- and has a no arg constructor. An instance of this type will be created to act
- as the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified.</param>
- <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> created for the repository.</returns>
- <exception cref="T:log4net.Core.LogException">The specified repository already exists.</exception>
- </member>
- <member name="M:log4net.LogManager.CreateRepository(System.String,System.Type)">
- <summary>
- Creates a repository with the specified name and repository type.
- </summary>
- <remarks>
- <para>
- The <paramref name="repository"/> name must be unique. Repositories cannot be redefined.
- An <see cref="T:System.Exception"/> will be thrown if the repository already exists.
- </para>
- </remarks>
- <param name="repository">The name of the repository, this must be unique to the repository.</param>
- <param name="repositoryType">A <see cref="T:System.Type"/> that implements <see cref="T:log4net.Repository.ILoggerRepository"/>
- and has a no arg constructor. An instance of this type will be created to act
- as the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified.</param>
- <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> created for the repository.</returns>
- <exception cref="T:log4net.Core.LogException">The specified repository already exists.</exception>
- </member>
- <member name="M:log4net.LogManager.CreateDomain(System.Reflection.Assembly,System.Type)">
- <summary>
- Creates a repository for the specified assembly and repository type.
- </summary>
- <remarks>
- <para>
- <b>CreateDomain is obsolete. Use CreateRepository instead of CreateDomain.</b>
- </para>
- <para>
- The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be associated with the repository
- specified such that a call to <see cref="M:GetRepository(Assembly)"/> with the
- same assembly specified will return the same repository instance.
- </para>
- </remarks>
- <param name="repositoryAssembly">The assembly to use to get the name of the repository.</param>
- <param name="repositoryType">A <see cref="T:System.Type"/> that implements <see cref="T:log4net.Repository.ILoggerRepository"/>
- and has a no arg constructor. An instance of this type will be created to act
- as the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified.</param>
- <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> created for the repository.</returns>
- </member>
- <member name="M:log4net.LogManager.CreateRepository(System.Reflection.Assembly,System.Type)">
- <summary>
- Creates a repository for the specified assembly and repository type.
- </summary>
- <remarks>
- <para>
- The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be associated with the repository
- specified such that a call to <see cref="M:GetRepository(Assembly)"/> with the
- same assembly specified will return the same repository instance.
- </para>
- </remarks>
- <param name="repositoryAssembly">The assembly to use to get the name of the repository.</param>
- <param name="repositoryType">A <see cref="T:System.Type"/> that implements <see cref="T:log4net.Repository.ILoggerRepository"/>
- and has a no arg constructor. An instance of this type will be created to act
- as the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified.</param>
- <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> created for the repository.</returns>
- </member>
- <member name="M:log4net.LogManager.GetAllRepositories">
- <summary>
- Gets the list of currently defined repositories.
- </summary>
- <remarks>
- <para>
- Get an array of all the <see cref="T:log4net.Repository.ILoggerRepository"/> objects that have been created.
- </para>
- </remarks>
- <returns>An array of all the known <see cref="T:log4net.Repository.ILoggerRepository"/> objects.</returns>
- </member>
- <member name="M:log4net.LogManager.WrapLogger(log4net.Core.ILogger)">
- <summary>
- Looks up the wrapper object for the logger specified.
- </summary>
- <param name="logger">The logger to get the wrapper for.</param>
- <returns>The wrapper for the logger specified.</returns>
- </member>
- <member name="M:log4net.LogManager.WrapLoggers(log4net.Core.ILogger[])">
- <summary>
- Looks up the wrapper objects for the loggers specified.
- </summary>
- <param name="loggers">The loggers to get the wrappers for.</param>
- <returns>The wrapper objects for the loggers specified.</returns>
- </member>
- <member name="M:log4net.LogManager.WrapperCreationHandler(log4net.Core.ILogger)">
- <summary>
- Create the <see cref="T:log4net.Core.ILoggerWrapper"/> objects used by
- this manager.
- </summary>
- <param name="logger">The logger to wrap.</param>
- <returns>The wrapper for the logger specified.</returns>
- </member>
- <member name="F:log4net.LogManager.s_wrapperMap">
- <summary>
- The wrapper map to use to hold the <see cref="T:log4net.Core.LogImpl"/> objects.
- </summary>
- </member>
- <member name="T:log4net.MDC">
- <summary>
- Implementation of Mapped Diagnostic Contexts.
- </summary>
- <remarks>
- <note>
- <para>
- The MDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Properties"/>.
- The current MDC implementation forwards to the <c>ThreadContext.Properties</c>.
- </para>
- </note>
- <para>
- The MDC class is similar to the <see cref="T:log4net.NDC"/> class except that it is
- based on a map instead of a stack. It provides <i>mapped
- diagnostic contexts</i>. A <i>Mapped Diagnostic Context</i>, or
- MDC in short, is an instrument for distinguishing interleaved log
- output from different sources. Log output is typically interleaved
- when a server handles multiple clients near-simultaneously.
- </para>
- <para>
- The MDC is managed on a per thread basis.
- </para>
- </remarks>
- <threadsafety static="true" instance="true"/>
- <author>Nicko Cadell</author>
- <author>Gert Driesen</author>
- </member>
- <member name="M:log4net.MDC.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:log4net.MDC"/> class.
- </summary>
- <remarks>
- Uses a private access modifier to prevent instantiation of this class.
- </remarks>
- </member>
- <member name="M:log4net.MDC.Get(System.String)">
- <summary>
- Gets the context value identified by the <paramref name="key"/> parameter.
- </summary>
- <param name="key">The key to lookup in the MDC.</param>
- <returns>The string value held for the key, or a <c>null</c> reference if no corresponding value is found.</returns>
- <remarks>
- <note>
- <para>
- The MDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Properties"/>.
- The current MDC implementation forwards to the <c>ThreadContext.Properties</c>.
- </para>
- </note>
- <para>
- If the <paramref name="key"/> parameter does not look up to a
- previously defined context then <c>null</c> will be returned.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.MDC.Set(System.String,System.String)">
- <summary>
- Add an entry to the MDC
- </summary>
- <param name="key">The key to store the value under.</param>
- <param name="value">The value to store.</param>
- <remarks>
- <note>
- <para>
- The MDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Properties"/>.
- The current MDC implementation forwards to the <c>ThreadContext.Properties</c>.
- </para>
- </note>
- <para>
- Puts a context value (the <paramref name="value"/> parameter) as identified
- with the <paramref name="key"/> parameter into the current thread's
- context map.
- </para>
- <para>
- If a value is already defined for the <paramref name="key"/>
- specified then the value will be replaced. If the <paramref name="value"/>
- is specified as <c>null</c> then the key value mapping will be removed.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.MDC.Remove(System.String)">
- <summary>
- Removes the key value mapping for the key specified.
- </summary>
- <param name="key">The key to remove.</param>
- <remarks>
- <note>
- <para>
- The MDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Properties"/>.
- The current MDC implementation forwards to the <c>ThreadContext.Properties</c>.
- </para>
- </note>
- <para>
- Remove the specified entry from this thread's MDC
- </para>
- </remarks>
- </member>
- <member name="M:log4net.MDC.Clear">
- <summary>
- Clear all entries in the MDC
- </summary>
- <remarks>
- <note>
- <para>
- The MDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Properties"/>.
- The current MDC implementation forwards to the <c>ThreadContext.Properties</c>.
- </para>
- </note>
- <para>
- Remove all the entries from this thread's MDC
- </para>
- </remarks>
- </member>
- <member name="T:log4net.NDC">
- <summary>
- Implementation of Nested Diagnostic Contexts.
- </summary>
- <remarks>
- <note>
- <para>
- The NDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Stacks"/>.
- The current NDC implementation forwards to the <c>ThreadContext.Stacks["NDC"]</c>.
- </para>
- </note>
- <para>
- A Nested Diagnostic Context, or NDC in short, is an instrument
- to distinguish interleaved log output from different sources. Log
- output is typically interleaved when a server handles multiple
- clients near-simultaneously.
- </para>
- <para>
- Interleaved log output can still be meaningful if each log entry
- from different contexts had a distinctive stamp. This is where NDCs
- come into play.
- </para>
- <para>
- Note that NDCs are managed on a per thread basis. The NDC class
- is made up of static methods that operate on the context of the
- calling thread.
- </para>
- </remarks>
- <example>How to push a message into the context
- <code lang="C#">
- using(NDC.Push("my context message"))
- {
- ... all log calls will have 'my context message' included ...
-
- } // at the end of the using block the message is automatically removed
- </code>
- </example>
- <threadsafety static="true" instance="true"/>
- <author>Nicko Cadell</author>
- <author>Gert Driesen</author>
- </member>
- <member name="M:log4net.NDC.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:log4net.NDC"/> class.
- </summary>
- <remarks>
- Uses a private access modifier to prevent instantiation of this class.
- </remarks>
- </member>
- <member name="M:log4net.NDC.Clear">
- <summary>
- Clears all the contextual information held on the current thread.
- </summary>
- <remarks>
- <note>
- <para>
- The NDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Stacks"/>.
- The current NDC implementation forwards to the <c>ThreadContext.Stacks["NDC"]</c>.
- </para>
- </note>
- <para>
- Clears the stack of NDC data held on the current thread.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.NDC.CloneStack">
- <summary>
- Creates a clone of the stack of context information.
- </summary>
- <returns>A clone of the context info for this thread.</returns>
- <remarks>
- <note>
- <para>
- The NDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Stacks"/>.
- The current NDC implementation forwards to the <c>ThreadContext.Stacks["NDC"]</c>.
- </para>
- </note>
- <para>
- The results of this method can be passed to the <see cref="M:log4net.NDC.Inherit(System.Collections.Stack)"/>
- method to allow child threads to inherit the context of their
- parent thread.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.NDC.Inherit(System.Collections.Stack)">
- <summary>
- Inherits the contextual information from another thread.
- </summary>
- <param name="stack">The context stack to inherit.</param>
- <remarks>
- <note>
- <para>
- The NDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Stacks"/>.
- The current NDC implementation forwards to the <c>ThreadContext.Stacks["NDC"]</c>.
- </para>
- </note>
- <para>
- This thread will use the context information from the stack
- supplied. This can be used to initialize child threads with
- the same contextual information as their parent threads. These
- contexts will <b>NOT</b> be shared. Any further contexts that
- are pushed onto the stack will not be visible to the other.
- Call <see cref="M:log4net.NDC.CloneStack"/> to obtain a stack to pass to
- this method.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.NDC.Pop">
- <summary>
- Removes the top context from the stack.
- </summary>
- <returns>
- The message in the context that was removed from the top
- of the stack.
- </returns>
- <remarks>
- <note>
- <para>
- The NDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Stacks"/>.
- The current NDC implementation forwards to the <c>ThreadContext.Stacks["NDC"]</c>.
- </para>
- </note>
- <para>
- Remove the top context from the stack, and return
- it to the caller. If the stack is empty then an
- empty string (not <c>null</c>) is returned.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.NDC.Push(System.String)">
- <summary>
- Pushes a new context message.
- </summary>
- <param name="message">The new context message.</param>
- <returns>
- An <see cref="T:System.IDisposable"/> that can be used to clean up
- the context stack.
- </returns>
- <remarks>
- <note>
- <para>
- The NDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Stacks"/>.
- The current NDC implementation forwards to the <c>ThreadContext.Stacks["NDC"]</c>.
- </para>
- </note>
- <para>
- Pushes a new context onto the context stack. An <see cref="T:System.IDisposable"/>
- is returned that can be used to clean up the context stack. This
- can be easily combined with the <c>using</c> keyword to scope the
- context.
- </para>
- </remarks>
- <example>Simple example of using the <c>Push</c> method with the <c>using</c> keyword.
- <code lang="C#">
- using(log4net.NDC.Push("NDC_Message"))
- {
- log.Warn("This should have an NDC message");
- }
- </code>
- </example>
- </member>
- <member name="M:log4net.NDC.Remove">
- <summary>
- Removes the context information for this thread. It is
- not required to call this method.
- </summary>
- <remarks>
- <note>
- <para>
- The NDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Stacks"/>.
- The current NDC implementation forwards to the <c>ThreadContext.Stacks["NDC"]</c>.
- </para>
- </note>
- <para>
- This method is not implemented.
- </para>
- </remarks>
- </member>
- <member name="M:log4net.NDC.SetMaxDepth(System.Int32)">
- <summary>
- Forces the stack depth to be at most <paramref name="maxDepth"/>.
- </summary>
- <param name="maxDepth">The maximum depth of the stack</param>
- <remarks>
- <note>
- <para>
- The NDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Stacks"/>.
- The current NDC implementation forwards to the <c>ThreadContext.Stacks["NDC"]</c>.
- </para>
- </note>
- <para>
- Forces the stack depth to be at most <paramref name="maxDepth"/>.
- This may truncate the head of the stack. This only affects the
- stack in the current thread. Also it does not prevent it from
- growing, it only sets the maximum depth at the time of the
- call. This can be used to return to a known context depth.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.NDC.Depth">
- <summary>
- Gets the current context depth.
- </summary>
- <value>The current context depth.</value>
- <remarks>
- <note>
- <para>
- The NDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Stacks"/>.
- The current NDC implementation forwards to the <c>ThreadContext.Stacks["NDC"]</c>.
- </para>
- </note>
- <para>
- The number of context values pushed onto the context stack.
- </para>
- <para>
- Used to record the current depth of the context. This can then
- be restored using the <see cref="M:log4net.NDC.SetMaxDepth(System.Int32)"/> method.
- </para>
- </remarks>
- <seealso cref="M:log4net.NDC.SetMaxDepth(System.Int32)"/>
- </member>
- <member name="T:log4net.ThreadContext">
- <summary>
- The log4net Thread Context.
- </summary>
- <remarks>
- <para>
- The <c>ThreadContext</c> provides a location for thread specific debugging
- information to be stored.
- The <c>ThreadContext</c> properties override any <see cref="T:log4net.GlobalContext"/>
- properties with the same name.
- </para>
- <para>
- The thread context has a properties map and a stack.
- The properties and stack can
- be included in the output of log messages. The <see cref="T:log4net.Layout.PatternLayout"/>
- supports selecting and outputting these properties.
- </para>
- <para>
- The Thread Context provides a diagnostic context for the current thread.
- This is an instrument for distinguishing interleaved log
- output from different sources. Log output is typically interleaved
- when a server handles multiple clients near-simultaneously.
- </para>
- <para>
- The Thread Context is managed on a per thread basis.
- </para>
- </remarks>
- <example>Example of using the thread context properties to store a username.
- <code lang="C#">
- ThreadContext.Properties["user"] = userName;
- log.Info("This log message has a ThreadContext Property called 'user'");
- </code>
- </example>
- <example>Example of how to push a message into the context stack
- <code lang="C#">
- using(ThreadContext.Stacks["NDC"].Push("my context message"))
- {
- log.Info("This log message has a ThreadContext Stack message that includes 'my context message'");
-
- } // at the end of the using block the message is automatically popped
- </code>
- </example>
- <threadsafety static="true" instance="true"/>
- <author>Nicko Cadell</author>
- </member>
- <member name="M:log4net.ThreadContext.#ctor">
- <summary>
- Private Constructor.
- </summary>
- <remarks>
- <para>
- Uses a private access modifier to prevent instantiation of this class.
- </para>
- </remarks>
- </member>
- <member name="F:log4net.ThreadContext.s_properties">
- <summary>
- The thread context properties instance
- </summary>
- </member>
- <member name="F:log4net.ThreadContext.s_stacks">
- <summary>
- The thread context stacks instance
- </summary>
- </member>
- <member name="P:log4net.ThreadContext.Properties">
- <summary>
- The thread properties map
- </summary>
- <value>
- The thread properties map
- </value>
- <remarks>
- <para>
- The <c>ThreadContext</c> properties override any <see cref="T:log4net.GlobalContext"/>
- properties with the same name.
- </para>
- </remarks>
- </member>
- <member name="P:log4net.ThreadContext.Stacks">
- <summary>
- The thread stacks
- </summary>
- <value>
- stack map
- </value>
- <remarks>
- <para>
- The thread local stacks.
- </para>
- </remarks>
- </member>
- </members>
-</doc>
diff --git a/SallyConnect/obj/Debug/DesignTimeResolveAssemblyReferencesInput.cache b/SallyConnect/obj/Debug/DesignTimeResolveAssemblyReferencesInput.cache
deleted file mode 100644
index ca653c2a46d6a4958cb52c08e81fe0dbead54025..0000000000000000000000000000000000000000
Binary files a/SallyConnect/obj/Debug/DesignTimeResolveAssemblyReferencesInput.cache and /dev/null differ
diff --git a/SallyConnect/obj/Debug/SallyConnect.csproj.FileListAbsolute.txt b/SallyConnect/obj/Debug/SallyConnect.csproj.FileListAbsolute.txt
deleted file mode 100644
index ade41f0a59f8ebe228b1a8c8d314a1a1cf74947f..0000000000000000000000000000000000000000
--- a/SallyConnect/obj/Debug/SallyConnect.csproj.FileListAbsolute.txt
+++ /dev/null
@@ -1,20 +0,0 @@
-C:\Users\Karan\documents\visual studio 2012\Projects\SallyConnect\SallyConnect\bin\Debug\SallyConnect.exe
-C:\Users\Karan\documents\visual studio 2012\Projects\SallyConnect\SallyConnect\bin\Debug\SallyConnect.pdb
-C:\Users\Karan\documents\visual studio 2012\Projects\SallyConnect\SallyConnect\bin\Debug\Apache.NMS.ActiveMQ.dll
-C:\Users\Karan\documents\visual studio 2012\Projects\SallyConnect\SallyConnect\bin\Debug\Apache.NMS.dll
-C:\Users\Karan\documents\visual studio 2012\Projects\SallyConnect\SallyConnect\bin\Debug\Apache.NMS.Stomp.dll
-C:\Users\Karan\documents\visual studio 2012\Projects\SallyConnect\SallyConnect\bin\Debug\commcore.dll
-C:\Users\Karan\documents\visual studio 2012\Projects\SallyConnect\SallyConnect\bin\Debug\commlmh.dll
-C:\Users\Karan\documents\visual studio 2012\Projects\SallyConnect\SallyConnect\bin\Debug\commmhworker.dll
-C:\Users\Karan\documents\visual studio 2012\Projects\SallyConnect\SallyConnect\bin\Debug\commplanetaryclient.dll
-C:\Users\Karan\documents\visual studio 2012\Projects\SallyConnect\SallyConnect\bin\Debug\commtheo.dll
-C:\Users\Karan\documents\visual studio 2012\Projects\SallyConnect\SallyConnect\bin\Debug\log4net.dll
-C:\Users\Karan\documents\visual studio 2012\Projects\SallyConnect\SallyConnect\bin\Debug\Apache.NMS.pdb
-C:\Users\Karan\documents\visual studio 2012\Projects\SallyConnect\SallyConnect\bin\Debug\Apache.NMS.ActiveMQ.pdb
-C:\Users\Karan\documents\visual studio 2012\Projects\SallyConnect\SallyConnect\bin\Debug\Apache.NMS.ActiveMQ.xml
-C:\Users\Karan\documents\visual studio 2012\Projects\SallyConnect\SallyConnect\bin\Debug\Apache.NMS.Stomp.pdb
-C:\Users\Karan\documents\visual studio 2012\Projects\SallyConnect\SallyConnect\bin\Debug\Apache.NMS.Stomp.xml
-C:\Users\Karan\documents\visual studio 2012\Projects\SallyConnect\SallyConnect\bin\Debug\log4net.xml
-C:\Users\Karan\documents\visual studio 2012\Projects\SallyConnect\SallyConnect\obj\Debug\SallyConnect.exe
-C:\Users\Karan\documents\visual studio 2012\Projects\SallyConnect\SallyConnect\obj\Debug\SallyConnect.pdb
-C:\Users\Karan\documents\visual studio 2012\Projects\SallyConnect\SallyConnect\obj\Debug\SallyConnect.csprojResolveAssemblyReference.cache
diff --git a/SallyConnect/obj/Debug/SallyConnect.csprojResolveAssemblyReference.cache b/SallyConnect/obj/Debug/SallyConnect.csprojResolveAssemblyReference.cache
deleted file mode 100644
index ab22211d9845b05e175f97ce0ff95af501d9a60e..0000000000000000000000000000000000000000
Binary files a/SallyConnect/obj/Debug/SallyConnect.csprojResolveAssemblyReference.cache and /dev/null differ
diff --git a/SallyConnect/obj/Debug/SallyConnect.exe b/SallyConnect/obj/Debug/SallyConnect.exe
deleted file mode 100644
index fa46768bc792f0dae1fd978f7ee84c800a6c4069..0000000000000000000000000000000000000000
Binary files a/SallyConnect/obj/Debug/SallyConnect.exe and /dev/null differ
diff --git a/SallyConnect/obj/Debug/SallyConnect.pdb b/SallyConnect/obj/Debug/SallyConnect.pdb
deleted file mode 100644
index 0a22bc0f00b476759c46663a7b2fab715e558fc6..0000000000000000000000000000000000000000
Binary files a/SallyConnect/obj/Debug/SallyConnect.pdb and /dev/null differ
diff --git a/SallyConnect/obj/Debug/TemporaryGeneratedFile_036C0B5B-1481-4323-8D20-8F5ADCB23D92.cs b/SallyConnect/obj/Debug/TemporaryGeneratedFile_036C0B5B-1481-4323-8D20-8F5ADCB23D92.cs
deleted file mode 100644
index e69de29bb2d1d6434b8b29ae775ad8c2e48c5391..0000000000000000000000000000000000000000
diff --git a/SallyConnect/obj/Debug/TemporaryGeneratedFile_5937a670-0e60-4077-877b-f7221da3dda1.cs b/SallyConnect/obj/Debug/TemporaryGeneratedFile_5937a670-0e60-4077-877b-f7221da3dda1.cs
deleted file mode 100644
index e69de29bb2d1d6434b8b29ae775ad8c2e48c5391..0000000000000000000000000000000000000000
diff --git a/SallyConnect/obj/Debug/TemporaryGeneratedFile_E7A71F73-0F8D-4B9B-B56E-8E70B10BC5D3.cs b/SallyConnect/obj/Debug/TemporaryGeneratedFile_E7A71F73-0F8D-4B9B-B56E-8E70B10BC5D3.cs
deleted file mode 100644
index e69de29bb2d1d6434b8b29ae775ad8c2e48c5391..0000000000000000000000000000000000000000