.\"     $Id: l4_mips_ipc_send.man,v 1.5 1998/12/16 02:50:59 gernot Exp $
.\"     Copyright (C) 1997, 1998 Kevin Elphinstone, University of New
.\"     South Wales.
.\"
.\"     This file is part of the L4/MIPS micro-kernel distribution.
.\"
.\"     This program is free software; you can redistribute it and/or
.\"     modify it under the terms of the GNU General Public License
.\"     as published by the Free Software Foundation; either version 2
.\"     of the License, or (at your option) any later version.
.\"     
.\"     This program is distributed in the hope that it will be useful,
.\"     but WITHOUT ANY WARRANTY; without even the implied warranty of
.\"     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
.\"     GNU General Public License for more details.
.\"     
.\"     You should have received a copy of the GNU General Public License
.\"     along with this program; if not, write to the Free Software
.\"     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
.TH L4_MIPS_IPC_SEND 2 "06.12.97" "CSE/UNSW" "System calls"
.SH NAME
l4_mips_ipc_send \- send a message to a thread
.SH "Synopsis"
.br
\fB#include <l4/ipc.h>\fP
.PP
\fBint l4_mips_ipc_send(l4_threadid_t\fP \fIdest\fP \fB, const void\fP
\fI*snd_msg\fP \fB, l4_ipc_reg_msg_t\fP \fI*snd_reg\fP \fB,
l4_timeout_t\fP \fItimeout\fP \fB, l4_msgdope_t\fP \fI*result\fP
\fB);\fP
.SH "Description"
\fIsnd_msg\fP is sent to the thread with id \fIdest\fP. There is no
receive phase included. The invoker continues working after sending
the message.
.SH "Arguments"
.IP "\fIdest\fP"
Thread id of the destination.
.IP "\fI*snd_msg\fP"
Pointer to a Send Descriptor. It can contain the 
following values:
.RS
.IP "<mem>" 
Ipc includes sending a message to the destination 
specified by \fIdest\fP. \fI*snd_msg\fP must point to a valid
message. The first 8 dwords of the message have to be given 
separately by the pointer \fI*snd_reg\fP.
.IP "\fB0\fP" 
Ipc includes sending a message to the destination specified by
\fIdest\fP. The message consists solely of the 8 dwords pointed to by
\fI*snd_reg\fP.
.RE
.IP "\fI*snd_reg\fP"
A pointer to the first 8 dwords to be transmitted in registers.
.IP "\fItimeout\fP"
This 32\-bit word specifies all 4 timeouts, the
quadruple (snd, rcv, snd pf, rcv pf). For a detailed description see
the L4 Reference Manual.
.IP "\fIresult\fP"
The message dope describing the result of the Ipc.
.SH "Return Values"
The following return values are possible:
.IP "\fB0\fP"
No error occured. The optional send operation was
successful, and if a receive operation was also specified, a message
was also received correctly. 
.IP "\fBL4_IPC_ENOT_EXISTENT\fP"
Non\-existing destination or source.
.IP "\fBL4_IPC_SETIMEOUT\fP"
Timeout during send operation.
.IP "\fBL4_IPC_SECANCELED\fP"
Send operation cancelled by another thread.
.IP "\fBL4_IPC_SEMAPFAILED\fP"
Map failed due to a shortage of page
tables during send operation.
.IP "\fBL4_IPC_SESNDPFTO\fP"
Send pagefault timeout.
.IP "\fBL4_IPC_SERCVPFTO\fP"
Receive pagefault timeout.
.IP "\fBL4_IPC_SEABORTED\fP"
Send operation aborted by another thread.
.IP "\fBL4_IPC_SEMSGCUT\fP"
Received message cut. Potential reasons
are:
.RS
.IP "(a)"
The recipient's mword buffer is too small.
.IP "(b)"
The recipient does not accept enough strings.
.IP "(c)"
At least one of the recipient's string buffers is too small.
.RE
.SH "See Also"
\fIl4_ipc\fP, 
\fIl4_mips_ipc_receive\fP, 
\fIl4_mips_ipc_chief_receive\fP, 
\fIl4_mips_ipc_reply_and_wait\fP, 
\fIl4_mips_ipc_reply_deceiving_and_wait\fP, 
\fIl4_mips_ipc_chief_reply_and_wait\fP, 
.\" \fIl4_mips_ipc_send\fP, 
\fIl4_mips_ipc_send_deceiving\fP, 
\fIl4_mips_ipc_chief_send\fP, 
\fIl4_mips_ipc_call\fP,
\fIl4_mips_ipc_chief_call\fP,
\fIl4_mips_ipc_wait\fP,
\fIl4_mips_ipc_chief_wait\fP,
\fIl4_mips_ipc_sleep\fP