xref: /titanic_41/usr/src/man/man9f/putctl1.9f (revision 3fb330b78c0911247d5eee86f7997a64a9a743e5)
te
Copyright 1989 AT&T
Copyright (c) 2006, Sun Microsystems, Inc.,
All Rights Reserved
The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
PUTCTL1 9F "Jan 16, 2006"
NAME
putctl1 - send a control message with a one-byte parameter to a queue
SYNOPSIS

#include <sys/stream.h>



int putctl1(queue_t *q, int type, int p);
INTERFACE LEVEL

Architecture independent level 1 (DDI/DKI).

PARAMETERS
q

Queue to which the message is to be sent.

type

Type of message.

p

One-byte parameter.

DESCRIPTION

The putctl1() function, like putctl(9F), tests the type argument to make sure a data type has not been specified, and attempts to allocate a message block. The p parameter can be used, for example, to specify how long the delay will be when an M_DELAY message is being sent. putctl1() fails if type is M_DATA, M_PROTO, or M_PCPROTO, or if a message block cannot be allocated. If successful, putctl1() calls the put(9E) routine of the queue pointed to by q with the newly allocated and initialized message.

RETURN VALUES

On success, 1 is returned. 0 is returned if type is a data type, or if a message block cannot be allocated.

CONTEXT

The putctl1() function can be called from user, interrupt, or kernel context.

EXAMPLES

See the putctl(9F) function page for an example of putctl1().

SEE ALSO

put(9E), allocb(9F), datamsg(9F), putctl(9F), putnextctl1(9F)

Writing Device Drivers

STREAMS Programming Guide