<?xml version="1.0" encoding="UTF-8"?>
<!--
 Licensed to the Apache Software Foundation (ASF) under one or more
 contributor license agreements. See the NOTICE file distributed with
 this work for additional information regarding copyright ownership.
 The ASF licenses this file to You under the Apache License, Version 2.0
 (the "License"); you may not use this file except in compliance with
 the License. You may obtain a copy of the License at
 
         http://www.apache.org/licenses/LICENSE-2.0
 
 Unless required by applicable law or agreed to in writing, software
 distributed under the License is distributed on an "AS IS" BASIS,
 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 See the License for the specific language governing permissions and
 limitations under the License.
-->
<document xmlns="http://maven.apache.org/XDOC/2.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 http://maven.apache.org/xsd/xdoc-2.0.xsd">

	<properties>
		<title>LoggerAppenderSocket</title>
	</properties>

	<body>
		<section name="LoggerAppenderSocket">
		
			<p><code>LoggerAppenderSocket</code> appends to a network socket.</p>
			
			<subsection name="Layout">
				<p>This appender requires a layout. If no layout is specified in configuration, 
				<code><a href="../layouts/serialized.html">LoggerLayoutSerialized</a></code> will be used by default.</p>
				
				<p>Prior to version <code>2.2</code>, a layout was not required.</p>
			</subsection>
			
			<subsection name="Parameters">
				<p>The following parameters are available:</p>
		
				<table>
					<thead>
						<tr>
							<th>Parameter</th>
							<th>Type</th>
							<th>Required</th>
							<th>Default</th>
							<th>Description</th>
						</tr>
					</thead>
					<tbody>
						<tr>
							<td>remoteHost</td>
							<td>string</td>
							<td><strong>Yes</strong></td>
							<td>-</td>
							<td>Target host. On how to define a remote hostname see <code>
							<a href="http://php.net/manual/en/function.fsockopen.php" class="external">fsockopen()</a>
							</code> documentation. </td>
						</tr>
						<tr>
							<td>port</td>
							<td>integer</td>
							<td>No</td>
							<td>4446</td>
							<td>Target port of the socket.</td>
						</tr>
						<tr>
							<td>timeout</td>
							<td>integer</td>
							<td>No</td>
							<td><code>ini_get('default_socket_timeout')</code></td>
							<td>Timeout in ms.</td>
						</tr>
					</tbody>
				</table>
			</subsection>
			
			<subsection name="Changelog">
				<table class="table table-striped table-bordered table-not-wide">
					<thead>
						<tr>
							<th>Version</th>
							<th>Description</th>
						</tr>
					</thead>
					<tbody>
						<tr>
							<td><code>2.2.0</code></td>
							<td>From this version, the socket appender uses a layout to format the logging events.
							Because of this change, the following parameters are no longer used: <code>useXml</code>,
							<code>locationInfo</code>, <code>log4jNamespace</code>. These settings can be configured
							on the layout.</td>
						</tr>
					</tbody>
				</table>
			</subsection>
				
			<subsection name="Examples">
				
				<p>In this example, log events are sent to a socket server at <code>localhost:4242</code>, using the 
				default (serialized) layout.</p>
				
				<div class="auto-tabs">
					<ul>
						<li>XML</li>
						<li>PHP</li>
					</ul>
 
					<div class="tab-content" >
						<div class="tab-pane">
<pre class="prettyprint"><![CDATA[
<configuration xmlns="http://logging.apache.org/log4php/">
    <appender name="default" class="LoggerAppenderSocket">
        <param name="remoteHost" value="localhost" />
        <param name="port" value="4242" />
    </appender>
    <root>
        <appender_ref ref="default" />
    </root>
</configuration>
]]></pre>
						</div>
						<div class="tab-pane">
<pre class="prettyprint"><![CDATA[
array(
    'appenders' => array(
        'default' => array(
            'class' => 'LoggerAppenderSocket',
            'params' => array(
                'remoteHost' => 'localhost',
                'port' => 4242
            ),
        ),
    ),
    'rootLogger' => array(
        'appenders' => array('default'),
    ),
);
]]></pre>
						</div>
					</div>
				</div>
			</subsection>
		</section>
	</body>
</document>
