Debian Codegraph @

doc/SystemTap_Tapset_Reference/man3/probe::socket.recvmsg.return.3stap

raw
1 '\" t
2 .\" Title: probe::socket.recvmsg.return
3 .\" Author:
4 .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
5 .\" Date: October 2025
6 .\" Manual: Socket Tapset
7 .\" Source: SystemTap Tapset Reference
8 .\" Language: English
9 .\"
10 .TH "PROBE::SOCKET\&.RECV" "3stap" "October 2025" "SystemTap Tapset Reference" "Socket Tapset"
11 .\" -----------------------------------------------------------------
12 .\" * Define some portability stuff
13 .\" -----------------------------------------------------------------
14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15 .\" http://bugs.debian.org/507673
16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
18 .ie \n(.g .ds Aq \(aq
19 .el .ds Aq '
20 .\" -----------------------------------------------------------------
21 .\" * set default formatting
22 .\" -----------------------------------------------------------------
23 .\" disable hyphenation
24 .nh
25 .\" disable justification (adjust text to left margin only)
26 .ad l
27 .\" -----------------------------------------------------------------
28 .\" * MAIN CONTENT STARTS HERE *
29 .\" -----------------------------------------------------------------
30 .SH "NAME"
31 probe::socket.recvmsg.return \- Return from Message being received on socket
32 .SH "SYNOPSIS"
33 .sp
34 .nf
35 socket\&.recvmsg\&.return
36 .fi
37 .SH "VALUES"
38 .PP
39 \fIname\fR
40 .RS 4
41 Name of this probe
42 .RE
43 .PP
44 \fIprotocol\fR
45 .RS 4
46 Protocol value
47 .RE
48 .PP
49 \fItype\fR
50 .RS 4
51 Socket type value
52 .RE
53 .PP
54 \fIstate\fR
55 .RS 4
56 Socket state value
57 .RE
58 .PP
59 \fIflags\fR
60 .RS 4
61 Socket flags value
62 .RE
63 .PP
64 \fIfamily\fR
65 .RS 4
66 Protocol family value
67 .RE
68 .PP
69 \fIsuccess\fR
70 .RS 4
71 Was receive successful? (1 = yes, 0 = no)
72 .RE
73 .PP
74 \fIsize\fR
75 .RS 4
76 Size of message received (in bytes) or error code if success = 0
77 .RE
78 .SH "CONTEXT"
79 .PP
80 The message receiver\&.
81 .SH "DESCRIPTION"
82 .PP
83 Fires at the conclusion of receiving a message on a socket via the
84 \fBsock_recvmsg\fR
85 function\&.
86 .SH SEE ALSO\n
87 .IR tapset::socket (3stap)