extra/zeromq/ffi/ffi.factor

   1 ! Copyright (C) 2011-2013 Eungju PARK, John Benediktsson.
   2 ! See http://factorcode.org/license.txt for BSD license.
   3
   4 USING: alien alien.accessors alien.c-types alien.data
   5 alien.libraries alien.syntax assocs byte-arrays classes.struct
   6 combinators kernel literals math system vocabs.platforms ;
   7
   8 IN: zeromq.ffi
   9
  10 LIBRARY-UNIX: zmq cdecl "libzmq.so"
  11 LIBRARY-MACOSX: zmq cdecl "libzmq.dylib"
  12 LIBRARY-WINDOWS: zmq cdecl "libzmq.dll"
  13
  14 LIBRARY: zmq
  15
  16 !
  17 ! 0MQ versioning support.
  18 !
  19
  20 ! Run-time API version detection
  21 FUNCTION: void zmq_version ( int* major, int* minor, int* patch )
  22
  23 !
  24 ! 0MQ errors.
  25 !
  26
  27 ! A number random enough not to collide with different errno ranges on
  28 ! different OSes. The assumption is that error_t is at least 32-bit type.
  29 << CONSTANT: ZMQ_HAUSNUMERO 156384712 >>
  30
  31 ! Native 0MQ error codes.
  32 CONSTANT: EFSM $[ ZMQ_HAUSNUMERO 51 + ]
  33 CONSTANT: ENOCOMPATPROTO $[ ZMQ_HAUSNUMERO 52 + ]
  34 CONSTANT: ETERM $[ ZMQ_HAUSNUMERO 53 + ]
  35 CONSTANT: EMTHREAD $[ ZMQ_HAUSNUMERO 54 + ]
  36
  37 ! This function retrieves the errno as it is known to 0MQ library. The goal
  38 ! of this function is to make the code 100% portable, including where 0MQ
  39 ! compiled with certain CRT library (on Windows) is linked to an
  40 ! application that uses different CRT library.
  41 FUNCTION: int zmq_errno ( )
  42
  43 ! Resolves system errors and 0MQ errors to human-readable string.
  44 FUNCTION: c-string zmq_strerror ( int errnum )
  45
  46 !
  47 ! 0MQ infrastructure (a.k.a. context) initialisation & termination.
  48 !
  49
  50 ! New API
  51 ! Context options
  52 CONSTANT: ZMQ_IO_THREADS  1
  53 CONSTANT: ZMQ_MAX_SOCKETS 2
  54
  55 ! Default for new contexts
  56 CONSTANT: ZMQ_IO_THREADS_DFLT  1
  57 CONSTANT: ZMQ_MAX_SOCKETS_DFLT 1024
  58
  59 FUNCTION: void* zmq_ctx_new ( )
  60 FUNCTION: int zmq_ctx_destroy ( void* context )
  61 FUNCTION: int zmq_ctx_set ( void* context, int option, int optval )
  62 FUNCTION: int zmq_ctx_get ( void* context, int option )
  63
  64 ! Old (legacy) API
  65 FUNCTION: void* zmq_init ( int io_threads )
  66 FUNCTION: int zmq_term ( void* context )
  67
  68 !
  69 ! 0MQ message definition.
  70 !
  71
  72 FUNCTION: int zmq_msg_init ( void* msg )
  73 FUNCTION: int zmq_msg_init_size ( void* msg, size_t size )
  74 FUNCTION: int zmq_msg_init_data ( void* msg, void* data, size_t size, void* ffn, void* hint )
  75 FUNCTION: int zmq_msg_send ( void* msg, void* s, int flags )
  76 FUNCTION: int zmq_msg_recv ( void* msg, void* s, int flags )
  77 FUNCTION: int zmq_msg_close ( void* msg )
  78 FUNCTION: int zmq_msg_move ( void* dest, void* src )
  79 FUNCTION: int zmq_msg_copy ( void* dest, void* src )
  80 FUNCTION: void* zmq_msg_data ( void* msg )
  81 FUNCTION: size_t zmq_msg_size ( void* msg )
  82 FUNCTION: int zmq_msg_more ( void* msg )
  83 FUNCTION: int zmq_msg_get ( void* msg, int option )
  84 FUNCTION: int zmq_msg_set ( void* msg, int option, int optval )
  85
  86 !
  87 ! 0MQ socket definition.
  88 !
  89
  90 ! Socket types.
  91 CONSTANT: ZMQ_PAIR 0
  92 CONSTANT: ZMQ_PUB 1
  93 CONSTANT: ZMQ_SUB 2
  94 CONSTANT: ZMQ_REQ 3
  95 CONSTANT: ZMQ_REP 4
  96 CONSTANT: ZMQ_DEALER 5
  97 CONSTANT: ZMQ_ROUTER 6
  98 CONSTANT: ZMQ_PULL 7
  99 CONSTANT: ZMQ_PUSH 8
 100 CONSTANT: ZMQ_XPUB 9
 101 CONSTANT: ZMQ_XSUB 10
 102
 103 ! Deprecated aliases
 104 ALIAS: ZMQ_XREQ ZMQ_DEALER
 105 ALIAS: ZMQ_XREP ZMQ_ROUTER
 106
 107 ! Socket options.
 108 CONSTANT: ZMQ_AFFINITY 4
 109 CONSTANT: ZMQ_IDENTITY 5
 110 CONSTANT: ZMQ_SUBSCRIBE 6
 111 CONSTANT: ZMQ_UNSUBSCRIBE 7
 112 CONSTANT: ZMQ_RATE 8
 113 CONSTANT: ZMQ_RECOVERY_IVL 9
 114 CONSTANT: ZMQ_SNDBUF 11
 115 CONSTANT: ZMQ_RCVBUF 12
 116 CONSTANT: ZMQ_RCVMORE 13
 117 CONSTANT: ZMQ_FD 14
 118 CONSTANT: ZMQ_EVENTS 15
 119 CONSTANT: ZMQ_TYPE 16
 120 CONSTANT: ZMQ_LINGER 17
 121 CONSTANT: ZMQ_RECONNECT_IVL 18
 122 CONSTANT: ZMQ_BACKLOG 19
 123 CONSTANT: ZMQ_RECONNECT_IVL_MAX 21
 124 CONSTANT: ZMQ_MAXMSGSIZE 22
 125 CONSTANT: ZMQ_SNDHWM 23
 126 CONSTANT: ZMQ_RCVHWM 24
 127 CONSTANT: ZMQ_MULTICAST_HOPS 25
 128 CONSTANT: ZMQ_RCVTIMEO 27
 129 CONSTANT: ZMQ_SNDTIMEO 28
 130 CONSTANT: ZMQ_IPV4ONLY 31
 131 CONSTANT: ZMQ_LAST_ENDPOINT 32
 132 CONSTANT: ZMQ_ROUTER_MANDATORY 33
 133 CONSTANT: ZMQ_TCP_KEEPALIVE 34
 134 CONSTANT: ZMQ_TCP_KEEPALIVE_CNT 35
 135 CONSTANT: ZMQ_TCP_KEEPALIVE_IDLE 36
 136 CONSTANT: ZMQ_TCP_KEEPALIVE_INTVL 37
 137 CONSTANT: ZMQ_TCP_ACCEPT_FILTER 38
 138 CONSTANT: ZMQ_DELAY_ATTACH_ON_CONNECT 39
 139 CONSTANT: ZMQ_XPUB_VERBOSE 40
 140
 141 ! Message options
 142 CONSTANT: ZMQ_MORE 1
 143
 144 ! Send/recv options.
 145 CONSTANT: ZMQ_DONTWAIT 1
 146 CONSTANT: ZMQ_SNDMORE 2
 147
 148 ! Deprecated aliases
 149 ALIAS: ZMQ_NOBLOCK ZMQ_DONTWAIT
 150 ALIAS: ZMQ_FAIL_UNROUTABLE ZMQ_ROUTER_MANDATORY
 151 ALIAS: ZMQ_ROUTER_BEHAVIOR ZMQ_ROUTER_MANDATORY
 152
 153 !
 154 ! 0MQ socket events and monitoring
 155 !
 156
 157 ! Socket transport events (tcp and ipc only)
 158 CONSTANT: ZMQ_EVENT_CONNECTED 1
 159 CONSTANT: ZMQ_EVENT_CONNECT_DELAYED 2
 160 CONSTANT: ZMQ_EVENT_CONNECT_RETRIED 4
 161
 162 CONSTANT: ZMQ_EVENT_LISTENING 8
 163 CONSTANT: ZMQ_EVENT_BIND_FAILED 16
 164
 165 CONSTANT: ZMQ_EVENT_ACCEPTED 32
 166 CONSTANT: ZMQ_EVENT_ACCEPT_FAILED 64
 167
 168 CONSTANT: ZMQ_EVENT_CLOSED 128
 169 CONSTANT: ZMQ_EVENT_CLOSE_FAILED 256
 170 CONSTANT: ZMQ_EVENT_DISCONNECTED 512
 171
 172 CONSTANT: ZMQ_EVENT_ALL flags{
 173     ZMQ_EVENT_CONNECTED ZMQ_EVENT_CONNECT_DELAYED
 174     ZMQ_EVENT_CONNECT_RETRIED ZMQ_EVENT_LISTENING
 175     ZMQ_EVENT_BIND_FAILED ZMQ_EVENT_ACCEPTED
 176     ZMQ_EVENT_ACCEPT_FAILED ZMQ_EVENT_CLOSED
 177     ZMQ_EVENT_CLOSE_FAILED ZMQ_EVENT_DISCONNECTED
 178 }
 179
 180 ! Socket event data (union member per event)
 181 STRUCT: zmq_event_t
 182     { event int }
 183     { addr c-string }
 184     { fd-or-err int } ;
 185
 186 FUNCTION: void* zmq_socket ( void* ctx, int type )
 187 FUNCTION: int zmq_close ( void* s )
 188 FUNCTION: int zmq_setsockopt ( void* s, int option, void* optval, size_t optvallen )
 189 FUNCTION: int zmq_getsockopt ( void* s, int option, void* optval, size_t* optvallen )
 190 FUNCTION: int zmq_bind ( void* s, c-string addr )
 191 FUNCTION: int zmq_connect ( void* s, c-string addr )
 192 FUNCTION: int zmq_unbind ( void* s, c-string addr )
 193 FUNCTION: int zmq_disconnect ( void* s, c-string addr )
 194 FUNCTION: int zmq_send ( void* s, void* buf, size_t len, int flags )
 195 FUNCTION: int zmq_recv ( void* s, void* buf, size_t len, int flags )
 196 FUNCTION: int zmq_socket_monitor ( void* s, c-string addr, int events )
 197
 198 FUNCTION: int zmq_sendmsg ( void* s, void* msg, int flags )
 199 FUNCTION: int zmq_recvmsg ( void* s, void* msg, int flags )
 200
 201 ! Experimental
 202 FUNCTION: int zmq_sendiov ( void* s, void* iov, size_t count, int flags )
 203 FUNCTION: int zmq_recviov ( void* s, void* iov, size_t* count, int flags )
 204
 205 !
 206 ! I/O multiplexing.
 207 !
 208
 209 CONSTANT: ZMQ_POLLIN 1
 210 CONSTANT: ZMQ_POLLOUT 2
 211 CONSTANT: ZMQ_POLLERR 4
 212
 213 ! FIXME: { fd SOCKET } on Windows
 214 STRUCT: zmq_pollitem_t
 215     { socket void* }
 216     { fd int }
 217     { events short }
 218     { revents short } ;
 219
 220 FUNCTION: int zmq_poll ( zmq_pollitem_t* items, int nitems, long timeout )
 221
 222 ! Built-in message proxy (3-way)
 223
 224 FUNCTION: int zmq_proxy ( void* frontend, void* backend, void* capture )
 225
 226 ! Deprecated aliases
 227 CONSTANT: ZMQ_STREAMER 1
 228 CONSTANT: ZMQ_FORWARDER 2
 229 CONSTANT: ZMQ_QUEUE 3
 230 ! Deprecated method
 231 FUNCTION: int zmq_device ( int type, void* frontend, void* backend )