1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
//! Connecting to KDB is pretty straightforward.
//! If you are using it embedded, then you can call new() with no parameters to connect to the
//! unerlying instance of KDB.
//! If you are using it externally, the call connect, which takes a host, port, credentials and an optional timeout.

use crate::any::Any;
use crate::error::{ConnectionError, Error};
use crate::k::K;
use crate::k_error::KError;
use crate::k_type::ERROR;
use crate::kapi;
use crate::kbox::KBox;

use std::ffi::CString;
use std::ptr;

/// null pointer with type inferred as *const K.
fn null() -> *const K {
    ptr::null()
}

macro_rules! evaluate {
    ($conn: expr, $func: expr $(, $param:expr)*,) => {
        evaluate!($conn, $func $(, $expr)*);
    };
    ($conn: expr, $func: expr $(, $param:expr)*) => {
        {
            let result = unsafe { kapi::k($conn, CString::new($func).unwrap().as_ptr() $(, $param.into_raw() as *const K)*, null()) };
            if result.is_null() {
                Err(Error::NetworkError)
            } else if $conn > 0 && unsafe { (*result).t == ERROR } {
                let err = unsafe{ KBox::<KError>::from_raw(result) }.into();
                Err(err)
            } else {
                Ok(result)
            }
        }
    };
}

fn from_raw(k: *mut K) -> KBox<Any> {
    unsafe { KBox::from_raw(k) }
}

/// Represents a connection to a remote or embedded KDB instance,
/// which can be used to send and query data on that instance.
pub struct Connection(i32);

impl Connection {
    /// [non-embedded only] Connect to a remote instance of KDB.
    #[cfg(not(feature = "embedded"))]
    pub fn connect(
        hostname: &str,
        port: u16,
        credentials: &str,
        timeout: Option<std::time::Duration>,
    ) -> Result<Self, ConnectionError> {
        let c_hostname = CString::new(hostname).unwrap();
        let c_credentials = CString::new(credentials).unwrap();

        let result = if let Some(duration) = timeout {
            let secs = duration.as_secs() as i32;
            unsafe { kapi::khpun(c_hostname.as_ptr(), port as i32, c_credentials.as_ptr(), secs) }
        } else {
            unsafe { kapi::khpu(c_hostname.as_ptr(), port as i32, c_credentials.as_ptr()) }
        };
        match result {
            0 => Err(ConnectionError::BadCredentials),
            -1 => Err(ConnectionError::CouldNotConnect),
            -2 => Err(ConnectionError::Timeout),
            x => Ok(Self(x)),
        }
    }

    /// [embedded only] Connect to an embedded KDB instance.
    #[cfg(any(feature = "embedded", doc))]
    pub fn new() -> Self {
        Connection(0)
    }

    /// [non-embedded only] Publish a value asynchronously to KDB.
    #[cfg(any(not(feature = "embedded"), doc))]
    pub fn publish(
        &self,
        callback: &str,
        topic: impl Into<KBox<Any>>,
        object: impl Into<KBox<Any>>,
    ) -> Result<(), Error> {
        // Note that when sending asynchronously, we shouldn't call r0 on the return value - it's
        // not an owned K type.
        evaluate!(-self.0, callback, topic.into(), object.into()).map(|_| ())
    }

    /// Evaluate a q expression with no parameters and return a result.
    pub fn eval(&self, query: &str) -> Result<KBox<Any>, Error> {
        evaluate!(self.0, query).map(from_raw)
    }

    /// Evaluate a q function with a single parameter and return the result.
    pub fn eval_1(&self, function: &str, param: impl Into<KBox<Any>>) -> Result<KBox<Any>, Error> {
        evaluate!(self.0, function, param.into()).map(from_raw)
    }

    /// Evaluate a q function with two parameters and return the result.
    pub fn eval_2(
        &self,
        function: &str,
        param: impl Into<KBox<Any>>,
        param_2: impl Into<KBox<Any>>,
    ) -> Result<KBox<Any>, Error> {
        evaluate!(self.0, function, param.into(), param_2.into()).map(from_raw)
    }

    /// Evaluate a q function with three parameters and return the result.
    pub fn eval_3(
        &self,
        function: &str,
        param: impl Into<KBox<Any>>,
        param_2: impl Into<KBox<Any>>,
        param_3: impl Into<KBox<Any>>,
    ) -> Result<KBox<Any>, Error> {
        evaluate!(self.0, function, param.into(), param_2.into(), param_3.into()).map(from_raw)
    }

    /// Evaluate a q function with four parameters and return the result.
    pub fn eval_4(
        &self,
        function: &str,
        param: impl Into<KBox<Any>>,
        param_2: impl Into<KBox<Any>>,
        param_3: impl Into<KBox<Any>>,
        param_4: impl Into<KBox<Any>>,
    ) -> Result<KBox<Any>, Error> {
        evaluate!(
            self.0,
            function,
            param.into(),
            param_2.into(),
            param_3.into(),
            param_4.into()
        )
        .map(from_raw)
    }

    /// Evaluate a q function with five parameters and return the result.
    pub fn eval_5(
        &self,
        function: &str,
        param: impl Into<KBox<Any>>,
        param_2: impl Into<KBox<Any>>,
        param_3: impl Into<KBox<Any>>,
        param_4: impl Into<KBox<Any>>,
        param_5: impl Into<KBox<Any>>,
    ) -> Result<KBox<Any>, Error> {
        evaluate!(
            self.0,
            function,
            param.into(),
            param_2.into(),
            param_3.into(),
            param_4.into(),
            param_5.into()
        )
        .map(from_raw)
    }

    /// Evaluate a q function with six parameters and return the result.
    #[allow(clippy::clippy::too_many_arguments)]
    pub fn eval_6(
        &self,
        function: &str,
        param: impl Into<KBox<Any>>,
        param_2: impl Into<KBox<Any>>,
        param_3: impl Into<KBox<Any>>,
        param_4: impl Into<KBox<Any>>,
        param_5: impl Into<KBox<Any>>,
        param_6: impl Into<KBox<Any>>,
    ) -> Result<KBox<Any>, Error> {
        evaluate!(
            self.0,
            function,
            param.into(),
            param_2.into(),
            param_3.into(),
            param_4.into(),
            param_5.into(),
            param_6.into()
        )
        .map(from_raw)
    }

    /// Evaluate a q function with seven parameters and return the result.
    #[allow(clippy::clippy::too_many_arguments)]
    pub fn eval_7(
        &self,
        function: &str,
        param: impl Into<KBox<Any>>,
        param_2: impl Into<KBox<Any>>,
        param_3: impl Into<KBox<Any>>,
        param_4: impl Into<KBox<Any>>,
        param_5: impl Into<KBox<Any>>,
        param_6: impl Into<KBox<Any>>,
        param_7: impl Into<KBox<Any>>,
    ) -> Result<KBox<Any>, Error> {
        evaluate!(
            self.0,
            function,
            param.into(),
            param_2.into(),
            param_3.into(),
            param_4.into(),
            param_5.into(),
            param_6.into(),
            param_7.into()
        )
        .map(from_raw)
    }

    /// See above and add one parameter.
    #[allow(clippy::clippy::too_many_arguments)]
    pub fn eval_8(
        &self,
        function: &str,
        param: impl Into<KBox<Any>>,
        param_2: impl Into<KBox<Any>>,
        param_3: impl Into<KBox<Any>>,
        param_4: impl Into<KBox<Any>>,
        param_5: impl Into<KBox<Any>>,
        param_6: impl Into<KBox<Any>>,
        param_7: impl Into<KBox<Any>>,
        param_8: impl Into<KBox<Any>>,
    ) -> Result<KBox<Any>, Error> {
        evaluate!(
            self.0,
            function,
            param.into(),
            param_2.into(),
            param_3.into(),
            param_4.into(),
            param_5.into(),
            param_6.into(),
            param_7.into(),
            param_8.into()
        )
        .map(from_raw)
    }
}

impl Drop for Connection {
    #[cfg(not(feature = "embedded"))]
    fn drop(&mut self) {
        unsafe {
            kapi::kclose(self.0);
        }
    }
    #[cfg(feature = "embedded")]
    fn drop(&mut self) {}
}

#[cfg(feature = "embedded")]
impl Default for Connection {
    fn default() -> Self {
        Connection(0)
    }
}