SCIMBridge  0.4.x
scim-bridge-messenger.h
Go to the documentation of this file.
1 /*
2  * SCIM Bridge
3  *
4  * Copyright (c) 2006 Ryo Dairiki <ryo-dairiki@users.sourceforge.net>
5  *
6  *
7  * This library is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Lesser General Public
9  * License as published by the Free Software Foundation and
10  * appearing in the file LICENSE.LGPL included in the package of this file.
11  * You can also redistribute it and/or modify it under the terms of
12  * the GNU General Public License as published by the Free Software Foundation and
13  * appearing in the file LICENSE.GPL included in the package of this file.
14  *
15  * This library is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
18  */
19 
25 #ifndef SCIMBRIDGEMESSAGENGER_H_
26 #define SCIMBRIDGEMESSAGENGER_H_
27 
28 #include "scim-bridge.h"
29 #include "scim-bridge-message.h"
30 
35 
36 #ifdef __cplusplus
37 extern "C"
38 {
39 #endif
40 
48 
56 
64 
72 
79  boolean scim_bridge_messenger_is_closed (const ScimBridgeMessenger *messenger);
80 
89 
98 
106  retval_t scim_bridge_messenger_send_message (ScimBridgeMessenger *messenger, const struct timeval *timeout);
107 
115  retval_t scim_bridge_messenger_receive_message (ScimBridgeMessenger *messenger, const struct timeval *timeout);
116 
125 
134 
135 #ifdef __cplusplus
136 }
137 #endif
138 #endif /*SCIMBRIDGEMESSAGENGER_H_*/
RETVAL_FAILED
#define RETVAL_FAILED
Definition: scim-bridge.h:64
scim-bridge-messenger.h
This header describes abut fucntions used for sending and receving messages.
scim-bridge.h
This header describes about fundamental definitions of scim-bridge.
RETVAL_SUCCEEDED
#define RETVAL_SUCCEEDED
Definition: scim-bridge.h:69
scim_bridge_messenger_push_message
retval_t scim_bridge_messenger_push_message(ScimBridgeMessenger *messenger, const ScimBridgeMessage *message)
Definition: scim-bridge-messenger.c:153
scim_bridge_alloc_message
ScimBridgeMessage * scim_bridge_alloc_message(const char *header, size_t argument_count)
Definition: scim-bridge-message.c:38
scim_bridge_messenger_receive_message
retval_t scim_bridge_messenger_receive_message(ScimBridgeMessenger *messenger, const struct timeval *timeout)
Definition: scim-bridge-messenger.c:434
scim-bridge-output.h
This header is used for print out error messages.
scim_bridge_close_messenger
retval_t scim_bridge_close_messenger(ScimBridgeMessenger *messenger)
Definition: scim-bridge-messenger.c:110
scim_bridge_message_get_header
const char * scim_bridge_message_get_header(const ScimBridgeMessage *message)
Definition: scim-bridge-message.c:86
scim_bridge_pdebugln
void scim_bridge_pdebugln(scim_bridge_debug_level_t level, const char *format,...)
Definition: scim-bridge-agent-output.cpp:81
scim_bridge_messenger_poll_message
retval_t scim_bridge_messenger_poll_message(ScimBridgeMessenger *messenger, ScimBridgeMessage **message)
Definition: scim-bridge-messenger.c:244
_ScimBridgeMessenger
Definition: scim-bridge-messenger.c:39
scim_bridge_messenger_send_message
retval_t scim_bridge_messenger_send_message(ScimBridgeMessenger *messenger, const struct timeval *timeout)
Definition: scim-bridge-messenger.c:347
scim_bridge_messenger_get_socket_fd
int scim_bridge_messenger_get_socket_fd(const ScimBridgeMessenger *messenger)
Definition: scim-bridge-messenger.c:140
scim-bridge-message.h
This header describes abut the data type of messages.
scim_bridge_messenger_get_receiving_buffer_size
ssize_t scim_bridge_messenger_get_receiving_buffer_size(const ScimBridgeMessenger *messenger)
Definition: scim-bridge-messenger.c:557
scim_bridge_messenger_is_closed
boolean scim_bridge_messenger_is_closed(const ScimBridgeMessenger *messenger)
Definition: scim-bridge-messenger.c:129
scim_bridge_free_messenger
void scim_bridge_free_messenger(ScimBridgeMessenger *messenger)
Definition: scim-bridge-messenger.c:96
scim_bridge_messenger_get_sending_buffer_size
ssize_t scim_bridge_messenger_get_sending_buffer_size(const ScimBridgeMessenger *messenger)
Definition: scim-bridge-messenger.c:543
scim_bridge_alloc_messenger
ScimBridgeMessenger * scim_bridge_alloc_messenger(int socket_fd)
Definition: scim-bridge-messenger.c:56
scim_bridge_message_get_argument
const char * scim_bridge_message_get_argument(const ScimBridgeMessage *message, size_t index)
Definition: scim-bridge-message.c:98
scim_bridge_perrorln
void scim_bridge_perrorln(const char *format,...)
Definition: scim-bridge-agent-output.cpp:103
scim_bridge_message_get_argument_count
size_t scim_bridge_message_get_argument_count(const ScimBridgeMessage *message)
Definition: scim-bridge-message.c:92
_ScimBridgeMessage
Definition: scim-bridge-message.c:29
scim_bridge_message_set_argument
retval_t scim_bridge_message_set_argument(ScimBridgeMessage *message, size_t index, const char *argument)
Definition: scim-bridge-message.c:114
retval_t
int retval_t
Definition: scim-bridge.h:59
scim_bridge_pdebug
void scim_bridge_pdebug(scim_bridge_debug_level_t level, const char *format,...)
Definition: scim-bridge-agent-output.cpp:92