/*
 * Copyright (c) 2008, 2020 Oracle and/or its affiliates. All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v. 2.0, which is available at
 * http://www.eclipse.org/legal/epl-2.0.
 *
 * This Source Code may also be made available under the following Secondary
 * Licenses when the conditions for such availability set forth in the
 * Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
 * version 2 with the GNU Classpath Exception, which is available at
 * https://www.gnu.org/software/classpath/license.html.
 *
 * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
 */

package org.glassfish.grizzly;

import org.glassfish.grizzly.utils.Holder;

Result of write operation, returned by Writeable.
Author:Alexey Stashok
Type parameters:
  • <K> – type of the message
  • <L> – type of the address
/** * Result of write operation, returned by {@link Writeable}. * * @param <K> type of the message * @param <L> type of the address * * @author Alexey Stashok */
public class WriteResult<K, L> implements Result, Cacheable { private static final ThreadCache.CachedTypeIndex<WriteResult> CACHE_IDX = ThreadCache.obtainIndex(WriteResult.class, 4); private boolean isRecycled = false; public static <K, L> WriteResult<K, L> create(Connection<L> connection) { final WriteResult<K, L> writeResult = takeFromCache(); if (writeResult != null) { writeResult.connection = connection; writeResult.isRecycled = false; return writeResult; } return new WriteResult<>(connection); } public static <K, L> WriteResult<K, L> create(final Connection<L> connection, final K message, final L dstAddress, final long writeSize) { final WriteResult<K, L> writeResult = takeFromCache(); if (writeResult != null) { writeResult.set(connection, message, dstAddress, writeSize); writeResult.isRecycled = false; return writeResult; } return new WriteResult<>(connection, message, dstAddress, writeSize); } @SuppressWarnings("unchecked") private static <K, L> WriteResult<K, L> takeFromCache() { return ThreadCache.takeFromCache(CACHE_IDX); }
Connection, from which data were read.
/** * Connection, from which data were read. */
private Connection<L> connection;
message data
/** * message data */
private K message;
Destination address.
/** * Destination address. */
private Holder<L> dstAddressHolder;
Number of bytes written.
/** * Number of bytes written. */
private long writtenSize; protected WriteResult() { } private WriteResult(final Connection<L> connection) { this(connection, null, null, 0); } private WriteResult(Connection<L> connection, K message, L dstAddress, long writeSize) { set(connection, message, dstAddress, writeSize); }
Get the Connection data were read from.
Returns:the Connection data were read from.
/** * Get the {@link Connection} data were read from. * * @return the {@link Connection} data were read from. */
@Override public final Connection<L> getConnection() { checkRecycled(); return connection; }
Get the message, which was read.
Returns:the message, which was read.
/** * Get the message, which was read. * * @return the message, which was read. */
public final K getMessage() { checkRecycled(); return message; }
Set the message, which was read.
Params:
  • message – the message, which was read.
/** * Set the message, which was read. * * @param message the message, which was read. */
public final void setMessage(K message) { checkRecycled(); this.message = message; }
Get the destination address, the message was written to.
Returns:the destination address, the message was written to.
/** * Get the destination address, the message was written to. * * @return the destination address, the message was written to. */
public final L getDstAddress() { checkRecycled(); return dstAddressHolder != null ? dstAddressHolder.get() : null; }
Get the destination address, the message was written to.
Returns:the destination address, the message was written to.
/** * Get the destination address, the message was written to. * * @return the destination address, the message was written to. */
public final Holder<L> getDstAddressHolder() { checkRecycled(); return dstAddressHolder; }
Set the destination address, the message was written to.
Params:
  • dstAddress – the destination address, the message was written to.
/** * Set the destination address, the message was written to. * * @param dstAddress the destination address, the message was written to. */
public final void setDstAddress(final L dstAddress) { checkRecycled(); this.dstAddressHolder = createAddrHolder(dstAddress); }
Set the destination address, the message was written to.
Params:
  • dstAddressHolder – the destination address, the message was written to.
/** * Set the destination address, the message was written to. * * @param dstAddressHolder the destination address, the message was written to. */
public final void setDstAddressHolder(final Holder<L> dstAddressHolder) { checkRecycled(); this.dstAddressHolder = dstAddressHolder; }
Get the number of bytes, which were written.
Returns:the number of bytes, which were written.
/** * Get the number of bytes, which were written. * * @return the number of bytes, which were written. */
public final long getWrittenSize() { checkRecycled(); return writtenSize; }
Set the number of bytes, which were written.
Params:
  • writeSize – the number of bytes, which were written.
/** * Set the number of bytes, which were written. * * @param writeSize the number of bytes, which were written. */
public final void setWrittenSize(long writeSize) { checkRecycled(); this.writtenSize = writeSize; } private void checkRecycled() { if (Grizzly.isTrackingThreadCache() && isRecycled) { throw new IllegalStateException("ReadResult has been recycled!"); } }
One method to set all the WriteResult properties.
Params:
  • connection –
  • message –
  • dstAddress –
  • writtenSize –
/** * One method to set all the WriteResult properties. * * @param connection * @param message * @param dstAddress * @param writtenSize */
protected void set(final Connection<L> connection, final K message, final L dstAddress, final long writtenSize) { this.connection = connection; this.message = message; this.dstAddressHolder = createAddrHolder(dstAddress); this.writtenSize = writtenSize; }
Create an address holder.
Params:
  • dstAddress –
Returns:
/** * Create an address holder. * * @param dstAddress * @return */
protected Holder<L> createAddrHolder(final L dstAddress) { return Holder.staticHolder(dstAddress); } protected void reset() { connection = null; message = null; dstAddressHolder = null; writtenSize = 0; } @Override public void recycle() { reset(); isRecycled = true; ThreadCache.putToCache(CACHE_IDX, this); } @Override public Object copy() { return WriteResult.create(getConnection(), getMessage(), getDstAddress(), getWrittenSize()); } }