03831d35f7499c87d51205817c93e9a8d42c4baestevel * CDDL HEADER START
03831d35f7499c87d51205817c93e9a8d42c4baestevel * The contents of this file are subject to the terms of the
03831d35f7499c87d51205817c93e9a8d42c4baestevel * Common Development and Distribution License, Version 1.0 only
03831d35f7499c87d51205817c93e9a8d42c4baestevel * (the "License"). You may not use this file except in compliance
03831d35f7499c87d51205817c93e9a8d42c4baestevel * with the License.
03831d35f7499c87d51205817c93e9a8d42c4baestevel * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
03831d35f7499c87d51205817c93e9a8d42c4baestevel * See the License for the specific language governing permissions
03831d35f7499c87d51205817c93e9a8d42c4baestevel * and limitations under the License.
03831d35f7499c87d51205817c93e9a8d42c4baestevel * When distributing Covered Code, include this CDDL HEADER in each
03831d35f7499c87d51205817c93e9a8d42c4baestevel * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
03831d35f7499c87d51205817c93e9a8d42c4baestevel * If applicable, add the following below this CDDL HEADER, with the
03831d35f7499c87d51205817c93e9a8d42c4baestevel * fields enclosed by brackets "[]" replaced with your own identifying
03831d35f7499c87d51205817c93e9a8d42c4baestevel * information: Portions Copyright [yyyy] [name of copyright owner]
03831d35f7499c87d51205817c93e9a8d42c4baestevel * CDDL HEADER END
03831d35f7499c87d51205817c93e9a8d42c4baestevel * Copyright 2002 Sun Microsystems, Inc. All rights reserved.
03831d35f7499c87d51205817c93e9a8d42c4baestevel * Use is subject to license terms.
03831d35f7499c87d51205817c93e9a8d42c4baestevel#pragma ident "%Z%%M% %I% %E% SMI"
03831d35f7499c87d51205817c93e9a8d42c4baestevelextern "C" {
03831d35f7499c87d51205817c93e9a8d42c4baestevel/* THIS IS CURRENTLY ONLY WRITTEN TO HANDLE A SINGLE PRODUCER, SINGLE */
03831d35f7499c87d51205817c93e9a8d42c4baestevel/* CONSUMER !!!!!!!!!!!!!!!! */
03831d35f7499c87d51205817c93e9a8d42c4baestevel/* Simple message queue */
03831d35f7499c87d51205817c93e9a8d42c4baestevel/* This package allows threads to pass simple messages through shared */
03831d35f7499c87d51205817c93e9a8d42c4baestevel/* local memory. The goal is to keep it simple and somewhat fast */
03831d35f7499c87d51205817c93e9a8d42c4baestevel/* smq_init() creates a simple message queue structure. It returns */
03831d35f7499c87d51205817c93e9a8d42c4baestevel/* 0 on success. You pass it a descriptor, the location of the buffer */
03831d35f7499c87d51205817c93e9a8d42c4baestevel/* where the messages will be stored, and the size of the buffer */
03831d35f7499c87d51205817c93e9a8d42c4baestevel/* (the number of messages that can be stored). The memory allocation */
03831d35f7499c87d51205817c93e9a8d42c4baestevel/* of the simple message buffer is the programmers responsibility. */
03831d35f7499c87d51205817c93e9a8d42c4baestevel/* smq_destroy() deativates a message queue structure */
03831d35f7499c87d51205817c93e9a8d42c4baestevel/* smq_receive() retrieves a message off of the simple message queue. */
03831d35f7499c87d51205817c93e9a8d42c4baestevel/* The message will be removed from the queue when this routine */
03831d35f7499c87d51205817c93e9a8d42c4baestevel/* returns. It suspends the thread until a message is received. */
03831d35f7499c87d51205817c93e9a8d42c4baestevel/* smq_send() places a message on the specified simple message queue. */
03831d35f7499c87d51205817c93e9a8d42c4baestevel/* It returns 0 on success. If the simple message queue is full, */
03831d35f7499c87d51205817c93e9a8d42c4baestevel/* SMQ_FULL is returned. */
03831d35f7499c87d51205817c93e9a8d42c4baestevel/* smq_pendingmsgs() returns the number of pending messages currently */
03831d35f7499c87d51205817c93e9a8d42c4baestevel/* on the queue. It returns 0 on success. */
03831d35f7499c87d51205817c93e9a8d42c4baestevel/* smq_depth() returns the depth of the queue. It returns 0 on */
03831d35f7499c87d51205817c93e9a8d42c4baestevel/* success. */
03831d35f7499c87d51205817c93e9a8d42c4baestevel/* smq_timedreceive() retrieves a message off of the simple message */
03831d35f7499c87d51205817c93e9a8d42c4baestevel/* queue. The message will be removed from the queue when this */
03831d35f7499c87d51205817c93e9a8d42c4baestevel/* routine returns. It suspends the thread until a message is */
03831d35f7499c87d51205817c93e9a8d42c4baestevel/* received or until 'timeout' has expired. It returns 0 on success */
03831d35f7499c87d51205817c93e9a8d42c4baestevel/* and SMQ_TIMEOUT if timeout has expired. */
03831d35f7499c87d51205817c93e9a8d42c4baestevel/* Do NOT read or write to these structures directly. They are */
03831d35f7499c87d51205817c93e9a8d42c4baestevel/* implementation dependent and may change over time */
03831d35f7499c87d51205817c93e9a8d42c4baestevel/* Be sure to declare any instantiation of these to be static if */
03831d35f7499c87d51205817c93e9a8d42c4baestevel/* you are alocating them on the stack */
03831d35f7499c87d51205817c93e9a8d42c4baesteveltypedef struct
03831d35f7499c87d51205817c93e9a8d42c4baestevelint smq_init(smq_t *smq, smq_msg_t *msgbuffer, int depth);
03831d35f7499c87d51205817c93e9a8d42c4baestevelint smq_xreceive(smq_t *smq, timestruc_t *timeout, smq_msg_t *msg);
03831d35f7499c87d51205817c93e9a8d42c4baestevel#endif /* _SMQ_H */