| <html xmlns:MSHelp="http://msdn.microsoft.com/mshelp" xmlns:mshelp="http://msdn.microsoft.com/mshelp"><head><link rel="SHORTCUT ICON" href="./../icons/favicon.ico" /><style type="text/css">.OH_CodeSnippetContainerTabLeftActive, .OH_CodeSnippetContainerTabLeft,.OH_CodeSnippetContainerTabLeftDisabled { backgroundImageName: tabLeftBG.gif; }.OH_CodeSnippetContainerTabRightActive, .OH_CodeSnippetContainerTabRight,.OH_CodeSnippetContainerTabRightDisabled { backgroundImageName: tabRightBG.gif; }.OH_footer { backgroundImageName: footer_slice.gif; background-position: top; background-repeat: repeat-x; }</style><link rel="stylesheet" type="text/css" href="./../styles/branding.css" /><link rel="stylesheet" type="text/css" href="./../styles/branding-en-US.css" /><style type="text/css"> |
| body |
| { |
| border-left:5px solid #e6e6e6; |
| overflow-x:scroll; |
| overflow-y:scroll; |
| } |
| </style><script src="./../scripts/branding.js" type="text/javascript"><!----></script><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>UdpAppender Class</title><meta name="Language" content="en-us" /><meta name="System.Keywords" content="UdpAppender class" /><meta name="System.Keywords" content="log4net.Appender.UdpAppender class" /><meta name="System.Keywords" content="UdpAppender class, about UdpAppender class" /><meta name="Microsoft.Help.F1" content="log4net.Appender.UdpAppender" /><meta name="Microsoft.Help.Id" content="T:log4net.Appender.UdpAppender" /><meta name="Description" content="Sends logging events as connectionless UDP datagrams to a remote host or a multicast group using an ." /><meta name="Microsoft.Help.ContentType" content="Reference" /><meta name="BrandingAware" content="'true'" /><meta name="container" content="log4net.Appender" /><meta name="file" content="T_log4net_Appender_UdpAppender" /><meta name="guid" content="T_log4net_Appender_UdpAppender" /><link type="text/css" rel="stylesheet" href="ms-help://Hx/HxRuntime/HxLink.css" /><link type="text/css" rel="stylesheet" href="./../styles/highlight.css" /><script type="text/javascript" src="../scripts/highlight.js"><!----></script><meta name="SelfBranded" content="true" /></head><body onload="onLoad()" class="primary-mtps-offline-document"><div class="OH_outerDiv"><div class="OH_outerContent"><table class="TitleTable"><tr><td class="OH_tdTitleColumn">UdpAppender Class</td><td class="OH_tdRunningTitleColumn">Apache log4net™ SDK Documentation</td></tr></table><div id="mainSection"><div id="mainBody"><span class="introStyle"></span><div class="summary"> |
| Sends logging events as connectionless UDP datagrams to a remote host or a |
| multicast group using an <img src="./../icons/online_icon.gif" class="OH_offlineIcon" alt="Online" title="Online" /><a href="http://msdn2.microsoft.com/en-us/library/9wkb9k12" target="_blank">UdpClient</a>. |
| </div><div class="OH_CollapsibleAreaRegion"><div class="OH_regiontitle">Inheritance Hierarchy</div><div class="OH_CollapsibleArea_HrDiv"><hr class="OH_CollapsibleArea_Hr" /></div></div><div class="OH_clear"></div><img src="./../icons/online_icon.gif" class="OH_offlineIcon" alt="Online" title="Online" /><a href="http://msdn2.microsoft.com/en-us/library/e5kfa45b" target="_blank">System<span id="ID0EBKOAAAAA"> </span><script type="text/javascript"> |
| addToLanSpecTextIdSet("ID0EBKOAAAAA?vb=.|cpp=::|cs=.|fs=.|nu=."); |
| </script>Object</a><br /> <a href="T_log4net_Appender_AppenderSkeleton.htm" target="">log4net.Appender<span id="ID0EBHOAAAAA"> </span><script type="text/javascript"> |
| addToLanSpecTextIdSet("ID0EBHOAAAAA?vb=.|cpp=::|cs=.|fs=.|nu=."); |
| </script>AppenderSkeleton</a><br /> <span class="selflink">log4net.Appender<span id="ID0EBEOAAAAA"> </span><script type="text/javascript"> |
| addToLanSpecTextIdSet("ID0EBEOAAAAA?vb=.|cpp=::|cs=.|fs=.|nu=."); |
| </script>UdpAppender</span><br /> <a href="T_log4net_Appender_RemoteSyslogAppender.htm" target="">log4net.Appender<span id="ID0EBBOAAAAA"> </span><script type="text/javascript"> |
| addToLanSpecTextIdSet("ID0EBBOAAAAA?vb=.|cpp=::|cs=.|fs=.|nu=."); |
| </script>RemoteSyslogAppender</a><br /><p></p><b>Namespace:</b> <a href="N_log4net_Appender.htm" target="">log4net.Appender</a><br /><b>Assembly:</b> <span sdata="assembly">log4net</span> (in log4net.dll) Version: 1.2.15.0 (1.2.15.0)<div class="OH_CollapsibleAreaRegion"><div class="OH_regiontitle">Syntax</div><div class="OH_CollapsibleArea_HrDiv"><hr class="OH_CollapsibleArea_Hr" /></div></div><div class="OH_clear"></div><div id="snippetGroup_Syntax" class="code"><div id="ID0ECAEAAAAA" class="OH_CodeSnippetContainer"><div class="OH_CodeSnippetContainerTabs" id="ID0ECAEAAAAA_tabs"><div class="OH_CodeSnippetContainerTabLeftActive" id="ID0ECAEAAAAA_tabimgleft"></div><div id="ID0ECAEAAAAA_tab1" class="OH_CodeSnippetContainerTabActive" EnableCopyCode="true"><a href="#" onclick="javascript:ChangeTab('ID0ECAEAAAAA','C#','1','4');return false;">C#</a></div><div id="ID0ECAEAAAAA_tab2" class="OH_CodeSnippetContainerTab" EnableCopyCode="true"><a href="#" onclick="javascript:ChangeTab('ID0ECAEAAAAA','Visual Basic','2','4');return false;">VB</a></div><div id="ID0ECAEAAAAA_tab3" class="OH_CodeSnippetContainerTab" EnableCopyCode="true"><a href="#" onclick="javascript:ChangeTab('ID0ECAEAAAAA','Visual C++','3','4');return false;">C++</a></div><div id="ID0ECAEAAAAA_tab4" class="OH_CodeSnippetContainerTabDisabledNotFirst" EnableCopyCode="true" disabled="true"><a>F#</a></div><div class="OH_CodeSnippetContainerTabRight" id="ID0ECAEAAAAA_tabimgright"></div></div><div id="ID0ECAEAAAAA_codecollection" class="OH_CodeSnippetContainerCodeCollection"><div class="OH_CodeSnippetToolBar"><div class="OH_CodeSnippetToolBarText"><a id="ID0ECAEAAAAA_ViewColorized" href="#" onclick="javascript:ExchangeTitleContent('ID0ECAEAAAAA','4')" title="View Colorized" style="display: none">View Colorized</a><a id="ID0ECAEAAAAA_copycode" href="#" onclick="javascript:CopyToClipboard('ID0ECAEAAAAA','4')" title="Copy to Clipboard">Copy to Clipboard</a><a id="ID0ECAEAAAAA_PrintText" class="OH_PrintText" href="#" onclick="javascript:Print('ID0ECAEAAAAA','4')" title="Print">Print</a></div></div><div id="ID0ECAEAAAAA_code_Div1" class="OH_CodeSnippetContainerCode" style="display: block"><pre><span class="keyword">public</span> <span class="keyword">class</span> <span class="identifier">UdpAppender</span> : <span class="identifier">AppenderSkeleton</span></pre></div><div id="ID0ECAEAAAAA_code_Plain_Div1" class="OH_CodeSnippetContainerCode" style="display: none"><pre>public class UdpAppender : AppenderSkeleton</pre></div><div id="ID0ECAEAAAAA_code_Div2" class="OH_CodeSnippetContainerCode" style="display: none"><pre><span class="keyword">Public</span> <span class="keyword">Class</span> <span class="identifier">UdpAppender</span> |
| <span class="keyword">Inherits</span> <span class="identifier">AppenderSkeleton</span></pre></div><div id="ID0ECAEAAAAA_code_Plain_Div2" class="OH_CodeSnippetContainerCode" style="display: none"><pre>Public Class UdpAppender |
| Inherits AppenderSkeleton</pre></div><div id="ID0ECAEAAAAA_code_Div3" class="OH_CodeSnippetContainerCode" style="display: none"><pre><span class="keyword">public</span> <span class="keyword">ref class</span> <span class="identifier">UdpAppender</span> : <span class="keyword">public</span> <span class="identifier">AppenderSkeleton</span></pre></div><div id="ID0ECAEAAAAA_code_Plain_Div3" class="OH_CodeSnippetContainerCode" style="display: none"><pre>public ref class UdpAppender : public AppenderSkeleton</pre></div><div id="ID0ECAEAAAAA_code_Div4" class="OH_CodeSnippetContainerCode" style="display: none"><pre /></div><div id="ID0ECAEAAAAA_code_Plain_Div4" class="OH_CodeSnippetContainerCode" style="display: none"><pre /></div></div></div><script>addSpecificTextLanguageTagSet('ID0ECAEAAAAA');</script></div><div class="OH_CollapsibleAreaRegion"><div class="OH_regiontitle">Remarks</div><div class="OH_CollapsibleArea_HrDiv"><hr class="OH_CollapsibleArea_Hr" /></div></div><div class="OH_clear"></div><p> |
| UDP guarantees neither that messages arrive, nor that they arrive in the correct order. |
| </p><p> |
| To view the logging results, a custom application can be developed that listens for logging |
| events. |
| </p><p> |
| 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 <a href="P_log4net_Appender_UdpAppender_Encoding.htm" target="">Encoding</a> |
| property to specify the encoding to use. |
| </p><div class="OH_CollapsibleAreaRegion"><div class="OH_regiontitle">Examples</div><div class="OH_CollapsibleArea_HrDiv"><hr class="OH_CollapsibleArea_Hr" /></div></div><div class="OH_clear"></div> |
| 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. |
| <div id="ID0EDCAAAAA" class="OH_CodeSnippetContainer"><div class="OH_CodeSnippetContainerTabs" id="ID0EDCAAAAA_tabs"><div class="OH_CodeSnippetContainerTabLeftActive" id="ID0EDCAAAAA_tabimgleft"></div><div id="ID0EDCAAAAA_tab1" class="OH_CodeSnippetContainerTabActive" EnableCopyCode="true"><a href="#" onclick="javascript:ChangeTab('ID0EDCAAAAA','C#','1','4');return false;">C#</a></div><div id="ID0EDCAAAAA_tab2" class="OH_CodeSnippetContainerTabDisabledNotFirst" EnableCopyCode="true" disabled="true"><a>VB</a></div><div id="ID0EDCAAAAA_tab3" class="OH_CodeSnippetContainerTabDisabledNotFirst" EnableCopyCode="true" disabled="true"><a>C++</a></div><div id="ID0EDCAAAAA_tab4" class="OH_CodeSnippetContainerTabDisabledNotFirst" EnableCopyCode="true" disabled="true"><a>F#</a></div><div class="OH_CodeSnippetContainerTabRight" id="ID0EDCAAAAA_tabimgright"></div></div><div id="ID0EDCAAAAA_codecollection" class="OH_CodeSnippetContainerCodeCollection"><div class="OH_CodeSnippetToolBar"><div class="OH_CodeSnippetToolBarText"><a id="ID0EDCAAAAA_ViewColorized" href="#" onclick="javascript:ExchangeTitleContent('ID0EDCAAAAA','4')" title="View Colorized" style="display: none">View Colorized</a><a id="ID0EDCAAAAA_copycode" href="#" onclick="javascript:CopyToClipboard('ID0EDCAAAAA','4')" title="Copy to Clipboard">Copy to Clipboard</a><a id="ID0EDCAAAAA_PrintText" class="OH_PrintText" href="#" onclick="javascript:Print('ID0EDCAAAAA','4')" title="Print">Print</a></div></div><div id="ID0EDCAAAAA_code_Div1" class="OH_CodeSnippetContainerCode" style="display: block"><pre>IPEndPoint remoteEndPoint = <span class="highlight-keyword">new</span> IPEndPoint(IPAddress.Any, <span class="highlight-number">0</span>); |
| UdpClient udpClient; |
| <span class="highlight-keyword">byte</span>[] buffer; |
| <span class="highlight-keyword">string</span> loggingEvent; |
| |
| <span class="highlight-keyword">try</span> |
| { |
| udpClient = <span class="highlight-keyword">new</span> UdpClient(<span class="highlight-number">8080</span>); |
| |
| <span class="highlight-keyword">while</span>(<span class="highlight-keyword">true</span>) |
| { |
| buffer = udpClient.Receive(<span class="highlight-keyword">ref</span> remoteEndPoint); |
| loggingEvent = System.Text.Encoding.Unicode.GetString(buffer); |
| Console.WriteLine(loggingEvent); |
| } |
| } |
| <span class="highlight-keyword">catch</span>(Exception e) |
| { |
| Console.WriteLine(e.ToString()); |
| }</pre></div><div id="ID0EDCAAAAA_code_Plain_Div1" class="OH_CodeSnippetContainerCode" style="display: none"><pre>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()); |
| }</pre></div><div id="ID0EDCAAAAA_code_Div2" class="OH_CodeSnippetContainerCode" style="display: none"><pre /></div><div id="ID0EDCAAAAA_code_Plain_Div2" class="OH_CodeSnippetContainerCode" style="display: none"><pre /></div><div id="ID0EDCAAAAA_code_Div3" class="OH_CodeSnippetContainerCode" style="display: none"><pre /></div><div id="ID0EDCAAAAA_code_Plain_Div3" class="OH_CodeSnippetContainerCode" style="display: none"><pre /></div><div id="ID0EDCAAAAA_code_Div4" class="OH_CodeSnippetContainerCode" style="display: none"><pre /></div><div id="ID0EDCAAAAA_code_Plain_Div4" class="OH_CodeSnippetContainerCode" style="display: none"><pre /></div></div></div><script>addSpecificTextLanguageTagSet('ID0EDCAAAAA');</script><div id="ID0ECCAAAAA" class="OH_CodeSnippetContainer"><div class="OH_CodeSnippetContainerTabs" id="ID0ECCAAAAA_tabs"></div><div id="ID0ECCAAAAA_codecollection" class="OH_CodeSnippetContainerCodeCollection"><div class="OH_CodeSnippetToolBar"><div class="OH_CodeSnippetToolBarText"><a id="ID0ECCAAAAA_ViewColorized" href="#" onclick="javascript:ExchangeTitleContent('ID0ECCAAAAA','4')" title="View Colorized" style="display: none">View Colorized</a><a id="ID0ECCAAAAA_copycode" href="#" onclick="javascript:CopyToClipboard('ID0ECCAAAAA','4')" title="Copy to Clipboard">Copy to Clipboard</a><a id="ID0ECCAAAAA_PrintText" class="OH_PrintText" href="#" onclick="javascript:Print('ID0ECCAAAAA','4')" title="Print">Print</a></div></div><div id="ID0ECCAAAAA_code_Div1" class="OH_CodeSnippetContainerCode" style="display: block"><pre>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</pre></div><div id="ID0ECCAAAAA_code_Plain_Div1" class="OH_CodeSnippetContainerCode" style="display: none"><pre>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</pre></div></div></div><script>addSpecificTextLanguageTagSet('ID0ECCAAAAA');</script><p> |
| An example configuration section to log information using this appender to the |
| IP 224.0.0.1 on port 8080: |
| </p><div id="ID0EACAAAAA" class="OH_CodeSnippetContainer"><div class="OH_CodeSnippetContainerTabs" id="ID0EACAAAAA_tabs"><div class="OH_CodeSnippetContainerTabLeft" id="ID0EACAAAAA_tabimgleft"></div><div id="ID0EACAAAAA_tab1" class="OH_CodeSnippetContainerTabSolo" EnableCopyCode="true"><a xmlns="">XML</a></div><div class="OH_CodeSnippetContainerTabRight" id="ID0EACAAAAA_tabimgright"></div></div><div id="ID0EACAAAAA_codecollection" class="OH_CodeSnippetContainerCodeCollection"><div class="OH_CodeSnippetToolBar"><div class="OH_CodeSnippetToolBarText"><a id="ID0EACAAAAA_ViewColorized" href="#" onclick="javascript:ExchangeTitleContent('ID0EACAAAAA','4')" title="View Colorized" style="display: none">View Colorized</a><a id="ID0EACAAAAA_copycode" href="#" onclick="javascript:CopyToClipboard('ID0EACAAAAA','4')" title="Copy to Clipboard">Copy to Clipboard</a><a id="ID0EACAAAAA_PrintText" class="OH_PrintText" href="#" onclick="javascript:Print('ID0EACAAAAA','4')" title="Print">Print</a></div></div><div id="ID0EACAAAAA_code_Div1" class="OH_CodeSnippetContainerCode" style="display: block"><pre><span class="highlight-xml-bracket"><</span><span class="highlight-xml-tag">appender</span> <span class="highlight-xml-attribute-name">name</span><span class="highlight-xml-attribute-equal">=</span><span class="highlight-xml-attribute-value">"UdpAppender"</span> <span class="highlight-xml-attribute-name">type</span><span class="highlight-xml-attribute-equal">=</span><span class="highlight-xml-attribute-value">"log4net.Appender.UdpAppender"</span><span class="highlight-xml-bracket">></span><span class="highlight-xml-bracket"><</span><span class="highlight-xml-tag">remoteAddress</span> <span class="highlight-xml-attribute-name">value</span><span class="highlight-xml-attribute-equal">=</span><span class="highlight-xml-attribute-value">"224.0.0.1"</span> <span class="highlight-xml-bracket">/></span><span class="highlight-xml-bracket"><</span><span class="highlight-xml-tag">remotePort</span> <span class="highlight-xml-attribute-name">value</span><span class="highlight-xml-attribute-equal">=</span><span class="highlight-xml-attribute-value">"8080"</span> <span class="highlight-xml-bracket">/></span><span class="highlight-xml-bracket"><</span><span class="highlight-xml-tag">layout</span> <span class="highlight-xml-attribute-name">type</span><span class="highlight-xml-attribute-equal">=</span><span class="highlight-xml-attribute-value">"log4net.Layout.PatternLayout"</span> <span class="highlight-xml-attribute-name">value</span><span class="highlight-xml-attribute-equal">=</span><span class="highlight-xml-attribute-value">"%-5level %logger [%ndc] - %message%newline"</span> <span class="highlight-xml-bracket">/></span><span class="highlight-xml-bracket"></</span><span class="highlight-xml-tag">appender</span><span class="highlight-xml-bracket">></span></pre></div><div id="ID0EACAAAAA_code_Plain_Div1" class="OH_CodeSnippetContainerCode" style="display: none"><pre><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></pre></div></div></div><script>addSpecificTextLanguageTagSet('ID0EACAAAAA');</script><a name="seeAlsoSection"><!----></a><div class="OH_CollapsibleAreaRegion"><div class="OH_regiontitle">See Also</div><div class="OH_CollapsibleArea_HrDiv"><hr class="OH_CollapsibleArea_Hr" /></div></div><div class="OH_clear"></div><div class="seeAlsoStyle"><a href="AllMembers_T_log4net_Appender_UdpAppender.htm" target="">UdpAppender Members</a></div><div class="seeAlsoStyle"><a href="N_log4net_Appender.htm" target="">log4net.Appender Namespace</a></div></div></div></div></div><div id="OH_footer" class="OH_footer"><p>Apache log4net, Apache and log4net are trademarks of The Apache Software Foundation.</p><p><a href="http://logging.apache.org/log4net/" target="_blank"><img src="./../icons/online_icon.gif" class="OH_offlineIcon" alt="Online" title="Online" /> |
| Copyright 2004-2015 The Apache Software Foundation (http://logging.apache.org/log4net/)</a></p><div class="OH_feedbacklink"><a href="mailto:http://logging.apache.org/log4net/mail-lists.html?subject=Apache+log4net%e2%84%a2+SDK+Documentation+UdpAppender+Class+100+EN-US&body=Your%20feedback%20is%20used%20to%20improve%20the%20documentation%20and%20the%20product.%20Your%20e-mail%20address%20will%20not%20be%20used%20for%20any%20other%20purpose%20and%20is%20disposed%20of%20after%20the%20issue%20you%20report%20is%20resolved.%20While%20working%20to%20resolve%20the%20issue%20that%20you%20report%2c%20you%20may%20be%20contacted%20via%20e-mail%20to%20get%20further%20details%20or%20clarification%20on%20the%20feedback%20you%20sent.%20After%20the%20issue%20you%20report%20has%20been%20addressed%2c%20you%20may%20receive%20an%20e-mail%20to%20let%20you%20know%20that%20your%20feedback%20has%20been%20addressed.">Send Feedback</a> on this topic to http://logging.apache.org/log4net/mail-lists.html.</div></div></body></html> |
