common/scim-bridge-messenger.h

Go to the documentation of this file.

/*
 * SCIM Bridge
 *
 * Copyright (c) 2006 Ryo Dairiki <ryo-dairiki@users.sourceforge.net>
 *
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation and 
 * appearing in the file LICENSE.LGPL included in the package of this file.
 * You can also redistribute it and/or modify it under the terms of 
 * the GNU General Public License as published by the Free Software Foundation and 
 * appearing in the file LICENSE.GPL included in the package of this file.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 */

#ifndef SCIMBRIDGEMESSAGENGER_H_
#define SCIMBRIDGEMESSAGENGER_H_

#include "scim-bridge.h"
#include "scim-bridge-message.h"

typedef struct _ScimBridgeMessenger ScimBridgeMessenger;

#ifdef __cplusplus
extern "C"
{
#endif

    ScimBridgeMessenger *scim_bridge_alloc_messenger (int socket_fd);

    void scim_bridge_free_messenger (ScimBridgeMessenger *messenger);

    int scim_bridge_messenger_get_socket_fd (const ScimBridgeMessenger *messenger);

    retval_t scim_bridge_close_messenger (ScimBridgeMessenger *messenger);

    boolean scim_bridge_messenger_is_closed (const ScimBridgeMessenger *messenger);

    retval_t scim_bridge_messenger_push_message (ScimBridgeMessenger *messenger, const ScimBridgeMessage *message);

    retval_t scim_bridge_messenger_poll_message (ScimBridgeMessenger *messenger, ScimBridgeMessage **message);

    retval_t scim_bridge_messenger_send_message (ScimBridgeMessenger *messenger, const struct timeval *timeout);

    retval_t scim_bridge_messenger_receive_message (ScimBridgeMessenger *messenger, const struct timeval *timeout);

    ssize_t scim_bridge_messenger_get_sending_buffer_size (const ScimBridgeMessenger *messenger);

    ssize_t scim_bridge_messenger_get_receiving_buffer_size (const ScimBridgeMessenger *messenger);

#ifdef __cplusplus
}
#endif
#endif                                            /*SCIMBRIDGEMESSAGENGER_H_*/