blob: fbdc5c27603bc37c2725d0057b22bf2817f4e337 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a>
<span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.2"></a>
<span class="sourceLineNo">003</span> * contributor license agreements. See the NOTICE file distributed with<a name="line.3"></a>
<span class="sourceLineNo">004</span> * this work for additional information regarding copyright ownership.<a name="line.4"></a>
<span class="sourceLineNo">005</span> * The ASF licenses this file to You under the Apache license, Version 2.0<a name="line.5"></a>
<span class="sourceLineNo">006</span> * (the "License"); you may not use this file except in compliance with<a name="line.6"></a>
<span class="sourceLineNo">007</span> * the License. You may obtain a copy of the License at<a name="line.7"></a>
<span class="sourceLineNo">008</span> *<a name="line.8"></a>
<span class="sourceLineNo">009</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a>
<span class="sourceLineNo">010</span> *<a name="line.10"></a>
<span class="sourceLineNo">011</span> * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a>
<span class="sourceLineNo">012</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a>
<span class="sourceLineNo">013</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a>
<span class="sourceLineNo">014</span> * See the license for the specific language governing permissions and<a name="line.14"></a>
<span class="sourceLineNo">015</span> * limitations under the license.<a name="line.15"></a>
<span class="sourceLineNo">016</span> */<a name="line.16"></a>
<span class="sourceLineNo">017</span><a name="line.17"></a>
<span class="sourceLineNo">018</span>package org.apache.logging.log4j.core.appender.mom.jeromq;<a name="line.18"></a>
<span class="sourceLineNo">019</span><a name="line.19"></a>
<span class="sourceLineNo">020</span>import java.util.Arrays;<a name="line.20"></a>
<span class="sourceLineNo">021</span>import java.util.List;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import java.util.concurrent.TimeUnit;<a name="line.22"></a>
<span class="sourceLineNo">023</span><a name="line.23"></a>
<span class="sourceLineNo">024</span>import org.apache.logging.log4j.LogManager;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import org.apache.logging.log4j.core.appender.AbstractManager;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import org.apache.logging.log4j.core.appender.ManagerFactory;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import org.apache.logging.log4j.core.util.ShutdownCallbackRegistry;<a name="line.27"></a>
<span class="sourceLineNo">028</span>import org.apache.logging.log4j.util.PropertiesUtil;<a name="line.28"></a>
<span class="sourceLineNo">029</span>import org.zeromq.ZMQ;<a name="line.29"></a>
<span class="sourceLineNo">030</span><a name="line.30"></a>
<span class="sourceLineNo">031</span>/**<a name="line.31"></a>
<span class="sourceLineNo">032</span> * Manager for publishing messages via JeroMq.<a name="line.32"></a>
<span class="sourceLineNo">033</span> *<a name="line.33"></a>
<span class="sourceLineNo">034</span> * @since 2.6<a name="line.34"></a>
<span class="sourceLineNo">035</span> */<a name="line.35"></a>
<span class="sourceLineNo">036</span>public class JeroMqManager extends AbstractManager {<a name="line.36"></a>
<span class="sourceLineNo">037</span><a name="line.37"></a>
<span class="sourceLineNo">038</span> /**<a name="line.38"></a>
<span class="sourceLineNo">039</span> * System property to enable shutdown hook.<a name="line.39"></a>
<span class="sourceLineNo">040</span> */<a name="line.40"></a>
<span class="sourceLineNo">041</span> public static final String SYS_PROPERTY_ENABLE_SHUTDOWN_HOOK = "log4j.jeromq.enableShutdownHook";<a name="line.41"></a>
<span class="sourceLineNo">042</span><a name="line.42"></a>
<span class="sourceLineNo">043</span> /**<a name="line.43"></a>
<span class="sourceLineNo">044</span> * System property to control JeroMQ I/O thread count.<a name="line.44"></a>
<span class="sourceLineNo">045</span> */<a name="line.45"></a>
<span class="sourceLineNo">046</span> public static final String SYS_PROPERTY_IO_THREADS = "log4j.jeromq.ioThreads";<a name="line.46"></a>
<span class="sourceLineNo">047</span><a name="line.47"></a>
<span class="sourceLineNo">048</span> private static final JeroMqManagerFactory FACTORY = new JeroMqManagerFactory();<a name="line.48"></a>
<span class="sourceLineNo">049</span> private static final ZMQ.Context CONTEXT;<a name="line.49"></a>
<span class="sourceLineNo">050</span><a name="line.50"></a>
<span class="sourceLineNo">051</span> static {<a name="line.51"></a>
<span class="sourceLineNo">052</span> LOGGER.trace("JeroMqManager using ZMQ version {}", ZMQ.getVersionString());<a name="line.52"></a>
<span class="sourceLineNo">053</span><a name="line.53"></a>
<span class="sourceLineNo">054</span> final int ioThreads = PropertiesUtil.getProperties().getIntegerProperty(SYS_PROPERTY_IO_THREADS, 1);<a name="line.54"></a>
<span class="sourceLineNo">055</span> LOGGER.trace("JeroMqManager creating ZMQ context with ioThreads = {}", ioThreads);<a name="line.55"></a>
<span class="sourceLineNo">056</span> CONTEXT = ZMQ.context(ioThreads);<a name="line.56"></a>
<span class="sourceLineNo">057</span><a name="line.57"></a>
<span class="sourceLineNo">058</span> final boolean enableShutdownHook = PropertiesUtil.getProperties().getBooleanProperty(<a name="line.58"></a>
<span class="sourceLineNo">059</span> SYS_PROPERTY_ENABLE_SHUTDOWN_HOOK, true);<a name="line.59"></a>
<span class="sourceLineNo">060</span> if (enableShutdownHook) {<a name="line.60"></a>
<span class="sourceLineNo">061</span> ((ShutdownCallbackRegistry) LogManager.getFactory()).addShutdownCallback(new Runnable() {<a name="line.61"></a>
<span class="sourceLineNo">062</span> @Override<a name="line.62"></a>
<span class="sourceLineNo">063</span> public void run() {<a name="line.63"></a>
<span class="sourceLineNo">064</span> CONTEXT.close();<a name="line.64"></a>
<span class="sourceLineNo">065</span> }<a name="line.65"></a>
<span class="sourceLineNo">066</span> });<a name="line.66"></a>
<span class="sourceLineNo">067</span> }<a name="line.67"></a>
<span class="sourceLineNo">068</span> }<a name="line.68"></a>
<span class="sourceLineNo">069</span><a name="line.69"></a>
<span class="sourceLineNo">070</span> private final ZMQ.Socket publisher;<a name="line.70"></a>
<span class="sourceLineNo">071</span><a name="line.71"></a>
<span class="sourceLineNo">072</span> private JeroMqManager(final String name, final JeroMqConfiguration config) {<a name="line.72"></a>
<span class="sourceLineNo">073</span> super(null, name);<a name="line.73"></a>
<span class="sourceLineNo">074</span> publisher = CONTEXT.socket(ZMQ.PUB);<a name="line.74"></a>
<span class="sourceLineNo">075</span> publisher.setAffinity(config.affinity);<a name="line.75"></a>
<span class="sourceLineNo">076</span> publisher.setBacklog(config.backlog);<a name="line.76"></a>
<span class="sourceLineNo">077</span> publisher.setDelayAttachOnConnect(config.delayAttachOnConnect);<a name="line.77"></a>
<span class="sourceLineNo">078</span> if (config.identity != null) {<a name="line.78"></a>
<span class="sourceLineNo">079</span> publisher.setIdentity(config.identity);<a name="line.79"></a>
<span class="sourceLineNo">080</span> }<a name="line.80"></a>
<span class="sourceLineNo">081</span> publisher.setIPv4Only(config.ipv4Only);<a name="line.81"></a>
<span class="sourceLineNo">082</span> publisher.setLinger(config.linger);<a name="line.82"></a>
<span class="sourceLineNo">083</span> publisher.setMaxMsgSize(config.maxMsgSize);<a name="line.83"></a>
<span class="sourceLineNo">084</span> publisher.setRcvHWM(config.rcvHwm);<a name="line.84"></a>
<span class="sourceLineNo">085</span> publisher.setReceiveBufferSize(config.receiveBufferSize);<a name="line.85"></a>
<span class="sourceLineNo">086</span> publisher.setReceiveTimeOut(config.receiveTimeOut);<a name="line.86"></a>
<span class="sourceLineNo">087</span> publisher.setReconnectIVL(config.reconnectIVL);<a name="line.87"></a>
<span class="sourceLineNo">088</span> publisher.setReconnectIVLMax(config.reconnectIVLMax);<a name="line.88"></a>
<span class="sourceLineNo">089</span> publisher.setSendBufferSize(config.sendBufferSize);<a name="line.89"></a>
<span class="sourceLineNo">090</span> publisher.setSendTimeOut(config.sendTimeOut);<a name="line.90"></a>
<span class="sourceLineNo">091</span> publisher.setSndHWM(config.sndHwm);<a name="line.91"></a>
<span class="sourceLineNo">092</span> publisher.setTCPKeepAlive(config.tcpKeepAlive);<a name="line.92"></a>
<span class="sourceLineNo">093</span> publisher.setTCPKeepAliveCount(config.tcpKeepAliveCount);<a name="line.93"></a>
<span class="sourceLineNo">094</span> publisher.setTCPKeepAliveIdle(config.tcpKeepAliveIdle);<a name="line.94"></a>
<span class="sourceLineNo">095</span> publisher.setTCPKeepAliveInterval(config.tcpKeepAliveInterval);<a name="line.95"></a>
<span class="sourceLineNo">096</span> publisher.setXpubVerbose(config.xpubVerbose);<a name="line.96"></a>
<span class="sourceLineNo">097</span> for (final String endpoint : config.endpoints) {<a name="line.97"></a>
<span class="sourceLineNo">098</span> publisher.bind(endpoint);<a name="line.98"></a>
<span class="sourceLineNo">099</span> }<a name="line.99"></a>
<span class="sourceLineNo">100</span> LOGGER.debug("Created JeroMqManager with {}", config);<a name="line.100"></a>
<span class="sourceLineNo">101</span> }<a name="line.101"></a>
<span class="sourceLineNo">102</span><a name="line.102"></a>
<span class="sourceLineNo">103</span> public boolean send(final byte[] data) {<a name="line.103"></a>
<span class="sourceLineNo">104</span> return publisher.send(data);<a name="line.104"></a>
<span class="sourceLineNo">105</span> }<a name="line.105"></a>
<span class="sourceLineNo">106</span><a name="line.106"></a>
<span class="sourceLineNo">107</span> @Override<a name="line.107"></a>
<span class="sourceLineNo">108</span> protected boolean releaseSub(final long timeout, final TimeUnit timeUnit) {<a name="line.108"></a>
<span class="sourceLineNo">109</span> publisher.close();<a name="line.109"></a>
<span class="sourceLineNo">110</span> return true;<a name="line.110"></a>
<span class="sourceLineNo">111</span> }<a name="line.111"></a>
<span class="sourceLineNo">112</span><a name="line.112"></a>
<span class="sourceLineNo">113</span> public static JeroMqManager getJeroMqManager(final String name, final long affinity, final long backlog,<a name="line.113"></a>
<span class="sourceLineNo">114</span> final boolean delayAttachOnConnect, final byte[] identity,<a name="line.114"></a>
<span class="sourceLineNo">115</span> final boolean ipv4Only, final long linger, final long maxMsgSize,<a name="line.115"></a>
<span class="sourceLineNo">116</span> final long rcvHwm, final long receiveBufferSize,<a name="line.116"></a>
<span class="sourceLineNo">117</span> final int receiveTimeOut, final long reconnectIVL,<a name="line.117"></a>
<span class="sourceLineNo">118</span> final long reconnectIVLMax, final long sendBufferSize,<a name="line.118"></a>
<span class="sourceLineNo">119</span> final int sendTimeOut, final long sndHwm, final int tcpKeepAlive,<a name="line.119"></a>
<span class="sourceLineNo">120</span> final long tcpKeepAliveCount, final long tcpKeepAliveIdle,<a name="line.120"></a>
<span class="sourceLineNo">121</span> final long tcpKeepAliveInterval, final boolean xpubVerbose,<a name="line.121"></a>
<span class="sourceLineNo">122</span> final List&lt;String&gt; endpoints) {<a name="line.122"></a>
<span class="sourceLineNo">123</span> return getManager(name, FACTORY,<a name="line.123"></a>
<span class="sourceLineNo">124</span> new JeroMqConfiguration(affinity, backlog, delayAttachOnConnect, identity, ipv4Only, linger, maxMsgSize,<a name="line.124"></a>
<span class="sourceLineNo">125</span> rcvHwm, receiveBufferSize, receiveTimeOut, reconnectIVL, reconnectIVLMax, sendBufferSize, sendTimeOut,<a name="line.125"></a>
<span class="sourceLineNo">126</span> sndHwm, tcpKeepAlive, tcpKeepAliveCount, tcpKeepAliveIdle, tcpKeepAliveInterval, xpubVerbose,<a name="line.126"></a>
<span class="sourceLineNo">127</span> endpoints));<a name="line.127"></a>
<span class="sourceLineNo">128</span> }<a name="line.128"></a>
<span class="sourceLineNo">129</span><a name="line.129"></a>
<span class="sourceLineNo">130</span> public static ZMQ.Context getContext() {<a name="line.130"></a>
<span class="sourceLineNo">131</span> return CONTEXT;<a name="line.131"></a>
<span class="sourceLineNo">132</span> }<a name="line.132"></a>
<span class="sourceLineNo">133</span><a name="line.133"></a>
<span class="sourceLineNo">134</span> private static class JeroMqConfiguration {<a name="line.134"></a>
<span class="sourceLineNo">135</span> private final long affinity;<a name="line.135"></a>
<span class="sourceLineNo">136</span> private final long backlog;<a name="line.136"></a>
<span class="sourceLineNo">137</span> private final boolean delayAttachOnConnect;<a name="line.137"></a>
<span class="sourceLineNo">138</span> private final byte[] identity;<a name="line.138"></a>
<span class="sourceLineNo">139</span> private final boolean ipv4Only;<a name="line.139"></a>
<span class="sourceLineNo">140</span> private final long linger;<a name="line.140"></a>
<span class="sourceLineNo">141</span> private final long maxMsgSize;<a name="line.141"></a>
<span class="sourceLineNo">142</span> private final long rcvHwm;<a name="line.142"></a>
<span class="sourceLineNo">143</span> private final long receiveBufferSize;<a name="line.143"></a>
<span class="sourceLineNo">144</span> private final int receiveTimeOut;<a name="line.144"></a>
<span class="sourceLineNo">145</span> private final long reconnectIVL;<a name="line.145"></a>
<span class="sourceLineNo">146</span> private final long reconnectIVLMax;<a name="line.146"></a>
<span class="sourceLineNo">147</span> private final long sendBufferSize;<a name="line.147"></a>
<span class="sourceLineNo">148</span> private final int sendTimeOut;<a name="line.148"></a>
<span class="sourceLineNo">149</span> private final long sndHwm;<a name="line.149"></a>
<span class="sourceLineNo">150</span> private final int tcpKeepAlive;<a name="line.150"></a>
<span class="sourceLineNo">151</span> private final long tcpKeepAliveCount;<a name="line.151"></a>
<span class="sourceLineNo">152</span> private final long tcpKeepAliveIdle;<a name="line.152"></a>
<span class="sourceLineNo">153</span> private final long tcpKeepAliveInterval;<a name="line.153"></a>
<span class="sourceLineNo">154</span> private final boolean xpubVerbose;<a name="line.154"></a>
<span class="sourceLineNo">155</span> private final List&lt;String&gt; endpoints;<a name="line.155"></a>
<span class="sourceLineNo">156</span><a name="line.156"></a>
<span class="sourceLineNo">157</span> private JeroMqConfiguration(final long affinity, final long backlog, final boolean delayAttachOnConnect,<a name="line.157"></a>
<span class="sourceLineNo">158</span> final byte[] identity, final boolean ipv4Only, final long linger,<a name="line.158"></a>
<span class="sourceLineNo">159</span> final long maxMsgSize, final long rcvHwm, final long receiveBufferSize,<a name="line.159"></a>
<span class="sourceLineNo">160</span> final int receiveTimeOut, final long reconnectIVL, final long reconnectIVLMax,<a name="line.160"></a>
<span class="sourceLineNo">161</span> final long sendBufferSize, final int sendTimeOut, final long sndHwm,<a name="line.161"></a>
<span class="sourceLineNo">162</span> final int tcpKeepAlive, final long tcpKeepAliveCount, final long tcpKeepAliveIdle,<a name="line.162"></a>
<span class="sourceLineNo">163</span> final long tcpKeepAliveInterval, final boolean xpubVerbose,<a name="line.163"></a>
<span class="sourceLineNo">164</span> final List&lt;String&gt; endpoints) {<a name="line.164"></a>
<span class="sourceLineNo">165</span> this.affinity = affinity;<a name="line.165"></a>
<span class="sourceLineNo">166</span> this.backlog = backlog;<a name="line.166"></a>
<span class="sourceLineNo">167</span> this.delayAttachOnConnect = delayAttachOnConnect;<a name="line.167"></a>
<span class="sourceLineNo">168</span> this.identity = identity;<a name="line.168"></a>
<span class="sourceLineNo">169</span> this.ipv4Only = ipv4Only;<a name="line.169"></a>
<span class="sourceLineNo">170</span> this.linger = linger;<a name="line.170"></a>
<span class="sourceLineNo">171</span> this.maxMsgSize = maxMsgSize;<a name="line.171"></a>
<span class="sourceLineNo">172</span> this.rcvHwm = rcvHwm;<a name="line.172"></a>
<span class="sourceLineNo">173</span> this.receiveBufferSize = receiveBufferSize;<a name="line.173"></a>
<span class="sourceLineNo">174</span> this.receiveTimeOut = receiveTimeOut;<a name="line.174"></a>
<span class="sourceLineNo">175</span> this.reconnectIVL = reconnectIVL;<a name="line.175"></a>
<span class="sourceLineNo">176</span> this.reconnectIVLMax = reconnectIVLMax;<a name="line.176"></a>
<span class="sourceLineNo">177</span> this.sendBufferSize = sendBufferSize;<a name="line.177"></a>
<span class="sourceLineNo">178</span> this.sendTimeOut = sendTimeOut;<a name="line.178"></a>
<span class="sourceLineNo">179</span> this.sndHwm = sndHwm;<a name="line.179"></a>
<span class="sourceLineNo">180</span> this.tcpKeepAlive = tcpKeepAlive;<a name="line.180"></a>
<span class="sourceLineNo">181</span> this.tcpKeepAliveCount = tcpKeepAliveCount;<a name="line.181"></a>
<span class="sourceLineNo">182</span> this.tcpKeepAliveIdle = tcpKeepAliveIdle;<a name="line.182"></a>
<span class="sourceLineNo">183</span> this.tcpKeepAliveInterval = tcpKeepAliveInterval;<a name="line.183"></a>
<span class="sourceLineNo">184</span> this.xpubVerbose = xpubVerbose;<a name="line.184"></a>
<span class="sourceLineNo">185</span> this.endpoints = endpoints;<a name="line.185"></a>
<span class="sourceLineNo">186</span> }<a name="line.186"></a>
<span class="sourceLineNo">187</span><a name="line.187"></a>
<span class="sourceLineNo">188</span> @Override<a name="line.188"></a>
<span class="sourceLineNo">189</span> public String toString() {<a name="line.189"></a>
<span class="sourceLineNo">190</span> return "JeroMqConfiguration{" +<a name="line.190"></a>
<span class="sourceLineNo">191</span> "affinity=" + affinity +<a name="line.191"></a>
<span class="sourceLineNo">192</span> ", backlog=" + backlog +<a name="line.192"></a>
<span class="sourceLineNo">193</span> ", delayAttachOnConnect=" + delayAttachOnConnect +<a name="line.193"></a>
<span class="sourceLineNo">194</span> ", identity=" + Arrays.toString(identity) +<a name="line.194"></a>
<span class="sourceLineNo">195</span> ", ipv4Only=" + ipv4Only +<a name="line.195"></a>
<span class="sourceLineNo">196</span> ", linger=" + linger +<a name="line.196"></a>
<span class="sourceLineNo">197</span> ", maxMsgSize=" + maxMsgSize +<a name="line.197"></a>
<span class="sourceLineNo">198</span> ", rcvHwm=" + rcvHwm +<a name="line.198"></a>
<span class="sourceLineNo">199</span> ", receiveBufferSize=" + receiveBufferSize +<a name="line.199"></a>
<span class="sourceLineNo">200</span> ", receiveTimeOut=" + receiveTimeOut +<a name="line.200"></a>
<span class="sourceLineNo">201</span> ", reconnectIVL=" + reconnectIVL +<a name="line.201"></a>
<span class="sourceLineNo">202</span> ", reconnectIVLMax=" + reconnectIVLMax +<a name="line.202"></a>
<span class="sourceLineNo">203</span> ", sendBufferSize=" + sendBufferSize +<a name="line.203"></a>
<span class="sourceLineNo">204</span> ", sendTimeOut=" + sendTimeOut +<a name="line.204"></a>
<span class="sourceLineNo">205</span> ", sndHwm=" + sndHwm +<a name="line.205"></a>
<span class="sourceLineNo">206</span> ", tcpKeepAlive=" + tcpKeepAlive +<a name="line.206"></a>
<span class="sourceLineNo">207</span> ", tcpKeepAliveCount=" + tcpKeepAliveCount +<a name="line.207"></a>
<span class="sourceLineNo">208</span> ", tcpKeepAliveIdle=" + tcpKeepAliveIdle +<a name="line.208"></a>
<span class="sourceLineNo">209</span> ", tcpKeepAliveInterval=" + tcpKeepAliveInterval +<a name="line.209"></a>
<span class="sourceLineNo">210</span> ", xpubVerbose=" + xpubVerbose +<a name="line.210"></a>
<span class="sourceLineNo">211</span> ", endpoints=" + endpoints +<a name="line.211"></a>
<span class="sourceLineNo">212</span> '}';<a name="line.212"></a>
<span class="sourceLineNo">213</span> }<a name="line.213"></a>
<span class="sourceLineNo">214</span> }<a name="line.214"></a>
<span class="sourceLineNo">215</span><a name="line.215"></a>
<span class="sourceLineNo">216</span> private static class JeroMqManagerFactory implements ManagerFactory&lt;JeroMqManager, JeroMqConfiguration&gt; {<a name="line.216"></a>
<span class="sourceLineNo">217</span> @Override<a name="line.217"></a>
<span class="sourceLineNo">218</span> public JeroMqManager createManager(final String name, final JeroMqConfiguration data) {<a name="line.218"></a>
<span class="sourceLineNo">219</span> return new JeroMqManager(name, data);<a name="line.219"></a>
<span class="sourceLineNo">220</span> }<a name="line.220"></a>
<span class="sourceLineNo">221</span> }<a name="line.221"></a>
<span class="sourceLineNo">222</span>}<a name="line.222"></a>
</pre>
</div>
</body>
</html>