/* SPDX-License-Identifier: Apache-2.0 */

/*
 * Copyright 2018-2022 Joel E. Anderson
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifndef __STUMPLESS_PRIVATE_TARGET_WEL_H
#  define __STUMPLESS_PRIVATE_TARGET_WEL_H

/* this must be included first to avoid errors */
#  include "private/windows_wrapper.h"

#  include <stddef.h>
#  include <stumpless/entry.h>

struct wel_target {
  HANDLE handle;
};

BOOL
destroy_wel_target( struct wel_target *target );

struct wel_target *
new_wel_target( LPCSTR server_name, LPCSTR source_name );

/**
 * Sends the provided entry and formatted message to the WEL target provided.
 *
 * **Thread Safety: MT-Safe race:msg**
 * This function is thread safe, using mutexes to coordinate accesses to the
 * target and entry. The msg is assumed to stay constant during the operation.
 *
 * **Async Signal Safety: AS-Unsafe lock heap**
 * This function is not safe to call from signal handlers due to the use of a
 * non-reentrant lock to coordinate changes and the use of memory management
 * functions to update internal structures.
 *
 * **Async Cancel Safety: AC-Unsafe lock heap**
 * This function is not safe to call from threads that may be asynchronously
 * cancelled, due to the use of a lock that could be left locked as well as
 * memory management functions.
 *
 * @param target The WEL target to send the entry to. Must not be NULL.
 *
 * @param entry The entry to send to the target. Must not be NULL.
 *
 * @param msg The formatted message string to send, as a UTF-8 string.
 *
 * @param msg_size The size of the formatted message in bytes.
 *
 * @return 1 upon success, -1 upon error.
 */
int
sendto_wel_target( const struct wel_target *target,
                   const struct stumpless_entry *entry,
                   const char *msg,
                   size_t msg_size );

#endif /* __STUMPLESS_PRIVATE_TARGET_WEL_H */