The Single UNIX ® Specification, Version 2
Copyright © 1997 The Open Group

 NAME

msgctl - message control operations

 SYNOPSIS



#include <sys/msg.h>

int msgctl(int msqid, int cmd, struct msqid_ds *buf);

 DESCRIPTION

The msgctl() function provides message control operations as specified by cmd. The following values for cmd, and the message control operations they specify, are:
IPC_STAT
Place the current value of each member of the msqid_ds data structure associated with msqid into the structure pointed to by buf. The contents of this structure are defined in <sys/msg.h>.
IPC_SET
Set the value of the following members of the msqid_ds data structure associated with msqid to the corresponding value found in the structure pointed to by buf:

msg_perm.uid
msg_perm.gid
msg_perm.mode
msg_qbytes

IPC_SET can only be executed by a process with appropriate privileges or that has an effective user ID equal to the value of msg_perm.cuid or msg_perm.uid in the msqid_ds data structure associated with msqid. Only a process with appropriate privileges can raise the value of msg_qbytes.
IPC_RMID
Remove the message queue identifier specified by msqid from the system and destroy the message queue and msqid_ds data structure associated with it. IPC_RMD can only be executed by a process with appropriate privileges or one that has an effective user ID equal to the value of msg_perm.cuid or msg_perm.uid in the msqid_ds data structure associated with msqid.

 RETURN VALUE

Upon successful completion, msgctl() returns 0. Otherwise, it returns -1 and errno will be set to indicate the error.

 ERRORS

The msgctl() function will fail if:
[EACCES]
The argument cmd is IPC_STAT and the calling process does not have read permission, see IPC.
[EINVAL]
The value of msqid is not a valid message queue identifier; or the value of cmd is not a valid command.
[EPERM]
The argument cmd is IPC_RMID or IPC_SET and the effective user ID of the calling process is not equal to that of a process with appropriate privileges and it is not equal to the value of msg_perm.cuid or msg_perm.uid in the data structure associated with msqid.
[EPERM]
The argument cmd is IPC_SET, an attempt is being made to increase to the value of msg_qbytes, and the effective user ID of the calling process does not have appropriate privileges.

 EXAMPLES

None.

 APPLICATION USAGE

The POSIX Realtime Extension defines alternative interfaces for interprocess communication. Application developers who need to use IPC should design their applications so that modules using the IPC routines described in IPC can be easily modified to use the alternative interfaces.

 FUTURE DIRECTIONS

None.

 SEE ALSO

mq_close(), mq_getattr(), mq_notify(), mq_open(), mq_receive(), mq_send(), mq_setattr(), mq_unlink(), msgget(), msgrcv(), msgsnd(), <sys/msg.h>, IPC.

DERIVATION

Derived from Issue 2 of the SVID.

UNIX ® is a registered Trademark of The Open Group.
Copyright © 1997 The Open Group
[ Main Index | XSH | XCU | XBD | XCURSES | XNS ]