com.codeminders.socketio.protocol.BinaryEventPacket Maven / Gradle / Ivy
/**
* The MIT License
* Copyright (c) 2015 Alexander Sova ([email protected])
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
package com.codeminders.socketio.protocol;
import java.io.InputStream;
import java.util.ArrayList;
import java.util.Collection;
import java.util.LinkedList;
import java.util.List;
/**
* Binary event packet class
*
* @author Alexander Sova ([email protected])
*/
public class BinaryEventPacket extends EventPacket implements BinaryPacket
{
private List attachments;
private int number_attachments_expected;
/**
* This constructor suppose to be called by parser when new packet arrived
*
* @param id packet id. Used for ACK
* @param name event name
* @param args event arguments as array of POJOs to be converted to JSON.
* @param number_attachments_expected number of binary attachment expected to be attached to this packed
*/
BinaryEventPacket(int id, String ns, String name, Object[] args, int number_attachments_expected)
{
super(Type.BINARY_EVENT, id, ns, name, args);
this.number_attachments_expected = number_attachments_expected;
this.attachments = new ArrayList<>(number_attachments_expected);
}
/**
* This constructor suppose to be called by user by emit() call
*
* @param id packet id
* @param ns packet namespace
* @param name event name
* @param args event arguments as array of POJOs to be converted to JSON.
* {@link java.io.InputStream} to be used for binary objects
*/
public BinaryEventPacket(int id, String ns, String name, Object[] args)
{
super(Type.BINARY_EVENT, id, ns, name, null);
attachments = new LinkedList<>();
// We know that extractBinaryObjects does not change the structure of the object,
// so we can safely case it to Object[]
setArgs((Object[]) SocketIOProtocol.extractBinaryObjects(args, attachments));
}
public Collection getAttachments()
{
return attachments;
}
@Override
protected String encodeAttachments()
{
return SocketIOProtocol.encodeAttachments(attachments.size());
}
/**
* @return true when all expected attachment arrived, false otherwise
*/
public boolean isComplete()
{
return number_attachments_expected == 0;
}
/**
* This method to be called when new attachement arrives to the socket
*
* @param attachment new attachment
*/
public void addAttachment(InputStream attachment)
{
attachments.add(attachment);
number_attachments_expected -= 1;
}
}