Macro cip_t

macro_rules! cip_t {
    ($tptoken: expr, $err_buffer: expr, $routine: expr, $($args: expr),* $(,)?) => { ... };
}

Make a FFI call to M using a cached function descriptor.

cip_t is equivalent to a variadic function with the following signature:

unsafe fn ci_t(tptoken: u64, err_buffer: Vec<u8>, routine: CallInDescriptor, ...) -> YDBResult<Vec<u8>>;

However, since Rust does not allow implementing variadic functions, it is a macro instead.

See also

• CallInDescriptor
• ci_t!, which has more information about call-ins in YottaDB.

Safety

Each argument passed (after routine) must correspond to the appropriate argument expected by routine. If routine returns a value, the first argument must be a pointer to an out parameter in which to store the value. All arguments must be representable as C types.

Example

Call the M routine described by HelloWorld1 in the call-in table. See also examples/m-ffi/helloworld1.m and examples/m-ffi/calltab.ci.

use std::env;
use std::ffi::CString;
use std::os::raw::c_char;
use yottadb::{craw, cip_t, CallInDescriptor, TpToken};

env::set_var("ydb_routines", "examples/m-ffi");
env::set_var("ydb_ci", "examples/m-ffi/calltab.ci");

let mut buf = Vec::<u8>::with_capacity(100);
let mut msg = craw::ydb_string_t { length: buf.capacity() as u64, address: buf.as_mut_ptr() as *mut c_char };
let mut routine = CallInDescriptor::new(CString::new("HelloWorld1").unwrap());
unsafe {
    cip_t!(TpToken::default(), Vec::new(), &mut routine, &mut msg as *mut _).unwrap();
    buf.set_len(msg.length as usize);
}
assert_eq!(&buf, b"entry called");