com.appunite.websocket.rx.object.ObjectWebSocketSender Maven / Gradle / Ivy

Go to download
/*
 * Copyright (C) 2015 Jacek Marchwicki 
 *
 * Licensed 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
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License
 */

package com.appunite.websocket.rx.object;

import com.appunite.websocket.rx.object.messages.RxObjectEventConnected;
import com.appunite.websocket.rx.object.messages.RxObjectEventDisconnected;

import java.io.IOException;

import javax.annotation.Nonnull;

/**
 * Interface that allows send object that is parsed and send via websocket to server
 *
 * It is valid since {@link RxObjectEventConnected} until
 * {@link RxObjectEventDisconnected}
 */
public interface ObjectWebSocketSender {
    /**
     * Send text message (thread safe). Can be called after onConnect and before
     * onDisconnect by any thread. Thread will be blocked until send
     *
     * @param message
     *            message to send
     * @throws IOException
     *             when exception occur while sending
     * @throws ObjectParseException
     *             when could not serialize object
     */
    void sendObjectMessage(@Nonnull Object message) throws IOException, ObjectParseException;
}