xref: /aosp_15_r20/external/iptables/extensions/libxt_IDLETIMER.man (revision a71a954618bbadd4a345637e5edcf36eec826889)
1*a71a9546SAutomerger Merge WorkerThis target can be used to identify when interfaces have been idle for a
2*a71a9546SAutomerger Merge Workercertain period of time.  Timers are identified by labels and are created when
3*a71a9546SAutomerger Merge Workera rule is set with a new label.  The rules also take a timeout value (in
4*a71a9546SAutomerger Merge Workerseconds) as an option.  If more than one rule uses the same timer label, the
5*a71a9546SAutomerger Merge Workertimer will be restarted whenever any of the rules get a hit.  One entry for
6*a71a9546SAutomerger Merge Workereach timer is created in sysfs.  This attribute contains the timer remaining
7*a71a9546SAutomerger Merge Workerfor the timer to expire.  The attributes are located under the xt_idletimer
8*a71a9546SAutomerger Merge Workerclass:
9*a71a9546SAutomerger Merge Worker.PP
10*a71a9546SAutomerger Merge Worker/sys/class/xt_idletimer/timers/<label>
11*a71a9546SAutomerger Merge Worker.PP
12*a71a9546SAutomerger Merge WorkerWhen the timer expires, the target module sends a sysfs notification to the
13*a71a9546SAutomerger Merge Workeruserspace, which can then decide what to do (eg. disconnect to save power).
14*a71a9546SAutomerger Merge Worker.TP
15*a71a9546SAutomerger Merge Worker\fB\-\-timeout\fP \fIamount\fP
16*a71a9546SAutomerger Merge WorkerThis is the time in seconds that will trigger the notification.
17*a71a9546SAutomerger Merge Worker.TP
18*a71a9546SAutomerger Merge Worker\fB\-\-label\fP \fIstring\fP
19*a71a9546SAutomerger Merge WorkerThis is a unique identifier for the timer.  The maximum length for the
20*a71a9546SAutomerger Merge Workerlabel string is 27 characters.
21*a71a9546SAutomerger Merge Worker.TP
22*a71a9546SAutomerger Merge Worker\fB\-\---send_nl_msg\fP
23*a71a9546SAutomerger Merge WorkerSend netlink messages in addition to sysfs notifications and show remaining
24*a71a9546SAutomerger Merge Workertime.
25