Skip to content

Commit

Permalink
#28 fix javadocs
Browse files Browse the repository at this point in the history
  • Loading branch information
kpavlov committed Jan 21, 2017
1 parent a70b76a commit 36ea603
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 6 deletions.
8 changes: 4 additions & 4 deletions core/src/main/java/fixio/netty/codec/FixMessageDecoder.java
Original file line number Diff line number Diff line change
Expand Up @@ -33,19 +33,19 @@

/**
* Decodes series of {@link ByteBuf}s into FixMessages.
* <p/>
* <p>
* Use following code to configure {@link io.netty.channel.ChannelPipeline}:
* </p>
* <pre><code>
* ChannelPipeline pipeline = ch.pipeline();
* pipeline.addLast("tagDecoder", new DelimiterBasedFrameDecoder(1024, Unpooled.wrappedBuffer(new byte[]{1})));
* pipeline.addLast("fixMessageDecoder", new FixMessageDecoder());
* pipeline.addLast("fixMessageEncoder", new FixMessageEncoder());
* </code></pre>
* <p/>
* FixMessageDecoder should be preceded in pipeline with {@link io.netty.handler.codec.DelimiterBasedFrameDecoder}, which is responsible for detecting FIX Protocol tags.
* <p>
* FixMessageDecoder should be preceded in pipeline with {@link io.netty.handler.codec.DelimiterBasedFrameDecoder},
* which is responsible for detecting FIX Protocol tags.
* </p>
* <p/>
* <p>
* <strong>This class is not thread safe!</strong>
* It should be a separate instance per {@link io.netty.channel.Channel}.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,8 @@ protected void prepareMessageToSend(ChannelHandlerContext ctx, FixSession sessio
/**
* Retrieves {@link FixSession} from context.
*
* @return null if session not established.
* @return FixSession or null, if session not established.
* @param ctx context
*/
protected FixSession getSession(ChannelHandlerContext ctx) {
Attribute<FixSession> fixSessionAttribute = ctx.channel().attr(FIX_SESSION_KEY);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,9 @@

/**
* Simple java bean FixSessionSettingsProvider implementation.
* <p/>
* <p>
* <strong>Thread-safety:</strong> This implementation is immutable and thread-safe.
* </p>
*/
public class FixSessionSettingsProviderImpl implements FixSessionSettingsProvider {

Expand Down

0 comments on commit 36ea603

Please sign in to comment.