+int asl_log_descriptor(asl_object_t asl, asl_object_t msg, int level, int descriptor, uint32_t fd_type) __API_DEPRECATED("os_log(3) has replaced asl(3)", macosx(10.8,10.12), ios(5.1,10.0), watchos(2.0,3.0), tvos(9.0,10.0));
+
+#pragma mark -
+
+
+/*!
+ * Creates a string representation of an ASL message.
+ *
+ * This utility creates a character string suitable for printing an ASL message.
+ * The returned string ends with a newline character. The caller is responsible
+ * for freeing the returned string.
+ * The message is formatted according to the specified format string. Timestamps
+ * are formatted accoring to the specified time format string. Special characters
+ * are enoded as specified by the text_encoding parameter.
+ *
+ * @param msg
+ * (input) An asl_object_t of type ASL_TYPE_MSG.
+ * @param fmt
+ * (input) A format specification string. See "Output file message and time formats"
+ * for standard formats. See the syslog(1) man page for more discussion on formats.
+ * @param fmt
+ * (input) A time format specification string. See "Output file message and time formats"
+ * for standard formats. See the syslog(1) man page for more discussion on time formats.
+ * @param text_encoding
+ * (input) Text encoding control (for special characters). See "Text Encoding Types".
+* @result Returns a character string, or NULL in case of a failure.
+ */
+char *asl_format(asl_object_t msg, const char *msg_fmt, const char *time_fmt, uint32_t text_encoding) __API_DEPRECATED("os_log(3) has replaced asl(3)", macosx(10.10,10.12), ios(8.0,10.0), watchos(2.0,3.0), tvos(9.0,10.0));
+
+/*!
+ * Encodes a buffer with embedded nul characters into a nul terminated C string.
+ * The result must be freed by the caller.
+ *
+ * This utility is used to encode the value associated with ASL_KEY_AUX_DATA
+ * in an ASL_TYPE_MSG object. An ASL_KEY_AUX_DATA key/value pair is used to hold the
+ * data written to a file descriptor created by asl_create_auxiliary_file on iOS
+ * systems, where the ASL database is stored in memory.
+ *
+ * @param buf
+ * (input) Pointer to a data buffer.
+ * @param len
+ * (input) Length (in octets) of data buffer.
+ * @result Returns an encoded character string.
+ */
+char *asl_encode_buffer(const char *buf, size_t len) __API_DEPRECATED("os_log(3) has replaced asl(3)", macosx(10.10,10.12), ios(8.0,10.0), watchos(2.0,3.0), tvos(9.0,10.0));
+
+/*!
+ * Decodes a C string previously created by asl_encode_buffer back into a buffer,
+ * possibly containing embedded nul characters. Allocates memory for the buffer
+ * and returns a pointer in an output parameter "buf".
+ * The caller is responsible for freeing the buffer.
+ *
+ * This routine should be used to decode the value associated with an
+ * ASL_KEY_AUX_DATA key in an ASL_TYPE_MSG object.
+ *
+ * @param in
+ * (input) Pointer to nul-terminated string created by asl_encode_buffer.
+ * @param buf
+ * (output) Pointer to a newly allocated data buffer.
+ * @param len
+ * (input) Length (in octets) of data buffer.
+ * @result Returns 0 on success, non-zero on failure.
+ */
+int asl_decode_buffer(const char *in, char **buf, size_t *len) __API_DEPRECATED("os_log(3) has replaced asl(3)", macosx(10.10,10.12), ios(8.0,10.0), watchos(2.0,3.0), tvos(9.0,10.0));
+
+/*!
+ * Iterate forward through messages in an asl_object_t.
+ * The asl_object_t object maintains an internal position index for the underlying
+ * collection of ASL messages, whether the asl_object_t represents a list, a
+ * data file, or an ASL database. The position index is moved forward and the
+ * "next" message is returned.
+ *
+ * @param obj
+ * (input) An asl_object_t.
+ * @result Returns the next message (an object of type ASL_TYPE_MSG or ASL_TYPE_QUERY) from the object,
+ * which should be of type ASL_TYPE_CLIENT, ASL_TYPE_LIST, ASL_TYPE_STORE, or ASL_TYPE_FILE.
+ * Returns NULL when there are no more messages or if obj is not a type that holds messages.
+ */
+asl_object_t asl_next(asl_object_t obj) __API_DEPRECATED("os_log(3) has replaced asl(3)", macosx(10.10,10.12), ios(8.0,10.0), watchos(2.0,3.0), tvos(9.0,10.0));
+
+/*!
+ * Iterate backwards through messages in an asl_object_t.
+ * The asl_object_t object maintains an internal position index for the underlying
+ * collection of ASL messages, whether the asl_object_t represents a list, a
+ * data file, or an ASL database. The position index is moved backward and the
+ * "previous" message is returned.
+ *
+ * @param data
+ * (input) An asl_object_t.
+ * @result Returns the previous message (an object of type ASL_TYPE_MSG or ASL_TYPE_QUERY) from the object,
+ * which should be of type ASL_TYPE_CLIENT, ASL_TYPE_LIST, ASL_TYPE_STORE, or ASL_TYPE_FILE.
+ * Returns NULL when there are no more messages or if obj is not a type that holds messages.
+ */
+asl_object_t asl_prev(asl_object_t obj) __API_DEPRECATED("os_log(3) has replaced asl(3)", macosx(10.10,10.12), ios(8.0,10.0), watchos(2.0,3.0), tvos(9.0,10.0));
+
+/*!
+ * Reset internal interation index in an asl_object_t.
+ *
+ * @param obj
+ * (input) An object of type ASL_TYPE_CLIENT, ASL_TYPE_LIST, ASL_TYPE_STORE, or ASL_TYPE_FILE.
+ * @param position
+ * (input) Use 0 to position the internal interation index at the beginning of the asl_object_t object,
+ * and SIZE_MAX to position it at the end. Other values of position may cause unpredictable behavior.
+ */
+void asl_reset_iteration(asl_object_t obj, size_t position) __API_DEPRECATED("os_log(3) has replaced asl(3)", macosx(10.10,10.12), ios(8.0,10.0), watchos(2.0,3.0), tvos(9.0,10.0));
+
+/*!
+ * Searches an asl_object_t.
+ * The search is controlled by a list of queries, and returns a list with matching messages.
+ * A message is returned if it matches any of the queries in the query list.
+ * A NULL querylist matches anything.
+ *
+ * The caller may provide a starting ASL message ID, a direction, and a count.
+ * A start ID value of 0 means that matching should commence at the beginning of the target obj.
+ * A value of SIZE_MAX indicates that matching should commence at the end (most recent message)
+ * in the target. If a non-zero count value is supplied, the routine will return when it has
+ * found that many messages, or it has checked all messages. If a non-zero duration is supplied,
+ * the routine will return after the specified time (in microseconds).
+ * If both count and duration are non-zero, the routine will return when the desired number of
+ * items has been matched or when the specified duration has been exceeded, whichever occurs first.
+ * The search direction may be ASL_MATCH_DIRECTION_FORWARD or ASL_MATCH_DIRECTION_REVERSE.
+ * The routine sets the value of the out parameter last to be an index of the last message
+ * checked while matching. To fetch matching messages in batches (using a small count or
+ * duration value), the start value for each iteration should be set to (last + 1) if searching
+ * forward, or (last - 1)for reverse search.
+ *
+ * @param data
+ * (input) An asl_object_t object.
+ * @param querylist
+ * (input) An asl_object_t object containing zero or more queries.
+ * @param last
+ * (output) An internal position index of the last message checked while matching in the asl_object_t object.
+ * @param start
+ * (input) A position index specifying where matching should commence.
+ * @param count
+ * (input) The maximum number of messages to be returned in the res output list (zero indicates no limit).
+ * @param duration
+ * (input) A limit (in microseconds) on the time to be spent searching for results. Zero indicates no time limit.
+ * @param direction
+ * (input) ASL_MATCH_DIRECTION_FORWARD or ASL_MATCH_DIRECTION_REVERSE.
+ * @result Returns an ASL object containing messages matching the querylist, or NULL if there are no matches.
+ */
+asl_object_t asl_match(asl_object_t data, asl_object_t querylist, size_t *last, size_t start, size_t count, uint32_t duration, int32_t direction) __API_DEPRECATED("os_log(3) has replaced asl(3)", macosx(10.10,10.12), ios(8.0,10.0), watchos(2.0,3.0), tvos(9.0,10.0));
projects / apple / syslog.git / blobdiff