2008-08-08 02:37:18 +02:00
|
|
|
/*
|
2012-06-04 22:31:44 +02:00
|
|
|
* Copyright 2012 The Netty Project
|
2008-08-08 02:37:18 +02:00
|
|
|
*
|
2011-12-09 06:18:34 +01:00
|
|
|
* The Netty Project 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:
|
2008-08-08 02:37:18 +02:00
|
|
|
*
|
2012-06-04 22:31:44 +02:00
|
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
2008-08-08 03:27:24 +02:00
|
|
|
*
|
2009-08-28 09:15:49 +02:00
|
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
|
|
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
2011-12-09 06:18:34 +01:00
|
|
|
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
2009-08-28 09:15:49 +02:00
|
|
|
* License for the specific language governing permissions and limitations
|
|
|
|
* under the License.
|
2008-08-08 02:37:18 +02:00
|
|
|
*/
|
2011-12-09 04:38:59 +01:00
|
|
|
package io.netty.handler.codec.serialization;
|
2008-08-08 02:37:18 +02:00
|
|
|
|
2012-05-17 09:38:25 +02:00
|
|
|
import io.netty.buffer.ChannelBuffer;
|
|
|
|
import io.netty.buffer.ChannelBufferOutputStream;
|
|
|
|
import io.netty.channel.ChannelOutboundHandlerContext;
|
|
|
|
import io.netty.handler.codec.MessageToStreamEncoder;
|
|
|
|
import io.netty.util.Attribute;
|
|
|
|
import io.netty.util.AttributeKey;
|
|
|
|
|
2008-09-04 07:48:41 +02:00
|
|
|
import java.io.ObjectInputStream;
|
2008-08-08 02:37:18 +02:00
|
|
|
import java.io.ObjectOutputStream;
|
|
|
|
import java.io.OutputStream;
|
2012-05-29 22:34:01 +02:00
|
|
|
import java.io.Serializable;
|
2008-08-08 02:37:18 +02:00
|
|
|
|
|
|
|
/**
|
2008-09-04 07:48:41 +02:00
|
|
|
* An encoder which serializes a Java object into a {@link ChannelBuffer}
|
|
|
|
* (interoperability version).
|
|
|
|
* <p>
|
|
|
|
* This encoder is interoperable with the standard Java object streams such as
|
|
|
|
* {@link ObjectInputStream} and {@link ObjectOutputStream}.
|
2008-08-08 02:37:18 +02:00
|
|
|
*/
|
2012-05-17 09:38:25 +02:00
|
|
|
public class CompatibleObjectEncoder extends MessageToStreamEncoder<Object> {
|
|
|
|
|
|
|
|
private static final AttributeKey<ObjectOutputStream> OOS =
|
2012-06-01 01:03:57 +02:00
|
|
|
new AttributeKey<ObjectOutputStream>(CompatibleObjectEncoder.class.getName() + ".oos");
|
2008-08-08 02:37:18 +02:00
|
|
|
|
|
|
|
private final int resetInterval;
|
|
|
|
private int writtenObjects;
|
|
|
|
|
2008-09-04 07:48:41 +02:00
|
|
|
/**
|
|
|
|
* Creates a new instance with the reset interval of {@code 16}.
|
|
|
|
*/
|
2008-08-08 02:37:18 +02:00
|
|
|
public CompatibleObjectEncoder() {
|
|
|
|
this(16); // Reset at every sixteen writes
|
|
|
|
}
|
|
|
|
|
2008-09-04 07:48:41 +02:00
|
|
|
/**
|
|
|
|
* Creates a new instance.
|
|
|
|
*
|
|
|
|
* @param resetInterval
|
|
|
|
* the number of objects between {@link ObjectOutputStream#reset()}.
|
|
|
|
* {@code 0} will disable resetting the stream, but the remote
|
|
|
|
* peer will be at the risk of getting {@link OutOfMemoryError} in
|
|
|
|
* the long term.
|
|
|
|
*/
|
2008-08-08 02:37:18 +02:00
|
|
|
public CompatibleObjectEncoder(int resetInterval) {
|
|
|
|
if (resetInterval < 0) {
|
|
|
|
throw new IllegalArgumentException(
|
|
|
|
"resetInterval: " + resetInterval);
|
|
|
|
}
|
|
|
|
this.resetInterval = resetInterval;
|
|
|
|
}
|
|
|
|
|
2008-09-04 07:48:41 +02:00
|
|
|
/**
|
|
|
|
* Creates a new {@link ObjectOutputStream} which wraps the specified
|
|
|
|
* {@link OutputStream}. Override this method to use a subclass of the
|
|
|
|
* {@link ObjectOutputStream}.
|
|
|
|
*/
|
|
|
|
protected ObjectOutputStream newObjectOutputStream(OutputStream out) throws Exception {
|
|
|
|
return new ObjectOutputStream(out);
|
|
|
|
}
|
|
|
|
|
2012-05-29 22:34:01 +02:00
|
|
|
@Override
|
|
|
|
public boolean isEncodable(Object msg) throws Exception {
|
|
|
|
return msg instanceof Serializable;
|
|
|
|
}
|
|
|
|
|
2008-12-17 08:38:32 +01:00
|
|
|
@Override
|
2012-05-17 09:38:25 +02:00
|
|
|
public void encode(ChannelOutboundHandlerContext<Object> ctx, Object msg, ChannelBuffer out) throws Exception {
|
|
|
|
Attribute<ObjectOutputStream> oosAttr = ctx.attr(OOS);
|
|
|
|
ObjectOutputStream oos = oosAttr.get();
|
|
|
|
if (oos == null) {
|
|
|
|
oos = newObjectOutputStream(new ChannelBufferOutputStream(out));
|
|
|
|
ObjectOutputStream newOos = oosAttr.setIfAbsent(oos);
|
|
|
|
if (newOos != null) {
|
|
|
|
oos = newOos;
|
2008-08-08 02:37:18 +02:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2012-05-17 09:38:25 +02:00
|
|
|
synchronized (oos) {
|
|
|
|
if (resetInterval != 0) {
|
|
|
|
// Resetting will prevent OOM on the receiving side.
|
|
|
|
writtenObjects ++;
|
|
|
|
if (writtenObjects % resetInterval == 0) {
|
|
|
|
oos.reset();
|
2008-12-08 10:02:33 +01:00
|
|
|
|
2012-05-17 09:38:25 +02:00
|
|
|
// Also discard the byproduct to avoid OOM on the sending side.
|
|
|
|
out.discardReadBytes();
|
2008-12-08 10:02:33 +01:00
|
|
|
}
|
|
|
|
}
|
2012-05-17 09:38:25 +02:00
|
|
|
|
|
|
|
oos.writeObject(msg);
|
|
|
|
oos.flush();
|
2008-12-08 10:02:33 +01:00
|
|
|
}
|
|
|
|
}
|
2008-08-08 02:37:18 +02:00
|
|
|
}
|