| ng_source.4 (dcc76067cdb88c6cd392ac5581c918c6457e400e) | ng_source.4 (c60bda17f2a9ed4a8c1ef6483ee7b8f207de7129) |
|---|---|
| 1.\" Copyright 2002-2007 Sandvine Inc. 2.\" All rights reserved. 3.\" 4.\" Subject to the following obligations and disclaimer of warranty, use and 5.\" redistribution of this software, in source or object code forms, with or 6.\" without modifications are expressly permitted by Sandvine Inc.; provided, 7.\" however, that: 8.\" 1. Any and all reproductions of the source or object code must include the --- 97 unchanged lines hidden (view full) --- 106sent, or upon receipt of a 107.Dv NGM_SOURCE_STOP 108message, the node stops sending data. 109.Sh CONTROL MESSAGES 110This node type supports the generic control messages as well as the following, 111which must be sent with the 112.Dv NGM_SOURCE_COOKIE 113attached. | 1.\" Copyright 2002-2007 Sandvine Inc. 2.\" All rights reserved. 3.\" 4.\" Subject to the following obligations and disclaimer of warranty, use and 5.\" redistribution of this software, in source or object code forms, with or 6.\" without modifications are expressly permitted by Sandvine Inc.; provided, 7.\" however, that: 8.\" 1. Any and all reproductions of the source or object code must include the --- 97 unchanged lines hidden (view full) --- 106sent, or upon receipt of a 107.Dv NGM_SOURCE_STOP 108message, the node stops sending data. 109.Sh CONTROL MESSAGES 110This node type supports the generic control messages as well as the following, 111which must be sent with the 112.Dv NGM_SOURCE_COOKIE 113attached. |
| 114.Bl -tag -width indent | 114.Bl -tag -width foo |
| 115.It Dv NGM_SOURCE_GET_STATS Pq Ic getstats 116Returns a structure containing the following fields: | 115.It Dv NGM_SOURCE_GET_STATS Pq Ic getstats 116Returns a structure containing the following fields: |
| 117.Bl -tag -width indent | 117.Bl -tag -width ".Va elapsedTime" |
| 118.It Va outOctets 119The number of octets/bytes sent out the 120.Va output 121hook. 122.It Va outFrames 123The number of frames/packets sent out the 124.Va output 125hook. --- 54 unchanged lines hidden (view full) --- 180.Vt uint32_t 181parameter which puts upper limit on the amount of packets 182sent per second. 183.It Dv NGM_SOURCE_SET_TIMESTAMP Pq Ic settimestamp 184This message specifies that a timestamp (in the format of a 185.Vt "struct timeval" ) 186should be inserted in the transmitted packets. 187This message requires a structure containing the following fields: | 118.It Va outOctets 119The number of octets/bytes sent out the 120.Va output 121hook. 122.It Va outFrames 123The number of frames/packets sent out the 124.Va output 125hook. --- 54 unchanged lines hidden (view full) --- 180.Vt uint32_t 181parameter which puts upper limit on the amount of packets 182sent per second. 183.It Dv NGM_SOURCE_SET_TIMESTAMP Pq Ic settimestamp 184This message specifies that a timestamp (in the format of a 185.Vt "struct timeval" ) 186should be inserted in the transmitted packets. 187This message requires a structure containing the following fields: |
| 188.Bl -tag -width indent | 188.Bl -tag -width ".Va offset" |
| 189.It Va offset 190The offset from the beginning of the packet at which the timestamp is to be 191inserted. 192.It Va flags 193Set to 1 to enable the timestamp. 194.El 195.It Dv NGM_SOURCE_GET_TIMESTAMP Pq Ic gettimestamp 196Returns the current timestamp settings in the form of the structure described 197above. 198.It Dv NGM_SOURCE_SET_COUNTER Pq Ic setcounter 199This message specifies that a counter should be embedded in transmitted 200packets. 201Up to four counters may be independently configured. 202This message requires a structure containing the following fields: | 189.It Va offset 190The offset from the beginning of the packet at which the timestamp is to be 191inserted. 192.It Va flags 193Set to 1 to enable the timestamp. 194.El 195.It Dv NGM_SOURCE_GET_TIMESTAMP Pq Ic gettimestamp 196Returns the current timestamp settings in the form of the structure described 197above. 198.It Dv NGM_SOURCE_SET_COUNTER Pq Ic setcounter 199This message specifies that a counter should be embedded in transmitted 200packets. 201Up to four counters may be independently configured. 202This message requires a structure containing the following fields: |
| 203.Bl -tag -width indent | 203.Bl -tag -width ".Va increment" |
| 204.It Va offset 205The offset from the beginning of the packet at which the counter is to be 206inserted. 207.It Va flags 208Set to 1 to enable the counter. 209.It Va width 210The byte width of the counter. 211It may be 1, 2, or 4. --- 138 unchanged lines hidden --- | 204.It Va offset 205The offset from the beginning of the packet at which the counter is to be 206inserted. 207.It Va flags 208Set to 1 to enable the counter. 209.It Va width 210The byte width of the counter. 211It may be 1, 2, or 4. --- 138 unchanged lines hidden --- |