| Junxiao Shi | 6c13562 | 2016-11-21 14:30:33 +0000 | [diff] [blame] | 1 | nfdc-face |
| 2 | ========= |
| 3 | |
| 4 | SYNOPSIS |
| 5 | -------- |
| 6 | | nfdc face [list] |
| Junxiao Shi | 1f481fa | 2017-01-26 15:14:43 +0000 | [diff] [blame^] | 7 | | nfdc face show <faceId> |
| Junxiao Shi | 6c13562 | 2016-11-21 14:30:33 +0000 | [diff] [blame] | 8 | | nfdc channel [list] |
| 9 | | nfdc create [-P] <faceUri> |
| 10 | | nfdc destroy <faceId|faceUri> |
| 11 | |
| 12 | DESCRIPTION |
| 13 | ----------- |
| 14 | In NFD, a face is the generalization of network interface. |
| 15 | It could be a physical network interface to communicate on a physical link, |
| 16 | an overlay communication channel between NFD and a remote node, |
| 17 | or an inter-process communication channel between NFD and a local application. |
| 18 | |
| 19 | The **nfdc face list** command shows a list of faces, their properties, and statistics. |
| 20 | |
| Junxiao Shi | 1f481fa | 2017-01-26 15:14:43 +0000 | [diff] [blame^] | 21 | The **nfdc face show** command shows properties and statistics of one specific face. |
| 22 | |
| Junxiao Shi | 6c13562 | 2016-11-21 14:30:33 +0000 | [diff] [blame] | 23 | The **nfdc channel list** command shows a list of channels. |
| 24 | Channels are listening sockets that can accept incoming connections and create new faces. |
| 25 | |
| 26 | The **nfdc create** command creates a new UDP or TCP face. |
| 27 | |
| 28 | The **nfdc destroy** command destroys an existing face. |
| 29 | It has no effect if the specified face does not exist. |
| 30 | |
| 31 | OPTIONS |
| 32 | ------- |
| 33 | -P |
| 34 | Creates a "permanent" rather than persistent face. |
| 35 | A persistent face is closed when a socket error occrs. |
| 36 | A permanent face is kept alive upon socket errors, |
| 37 | and is closed only upon **nfdc destroy** command. |
| 38 | |
| Junxiao Shi | 1f481fa | 2017-01-26 15:14:43 +0000 | [diff] [blame^] | 39 | <faceId> |
| 40 | Numerical identifier of the face. |
| 41 | It is displayed in the output of **nfdc face list** and **nfdc create** commands. |
| 42 | |
| Junxiao Shi | 6c13562 | 2016-11-21 14:30:33 +0000 | [diff] [blame] | 43 | <faceUri> |
| 44 | An URI representing the remote endpoint of a face. |
| 45 | Its syntax is: |
| 46 | |
| 47 | - udp[4|6]://<IP-or-host>[:<port>] |
| 48 | - tcp[4|6]://<IP-or-host>[:<port>] |
| 49 | |
| 50 | When a hostname is specified, a DNS query is used to obtain the IP address. |
| 51 | |
| Junxiao Shi | 1f481fa | 2017-01-26 15:14:43 +0000 | [diff] [blame^] | 52 | EXIT CODES |
| 53 | ---------- |
| 54 | |
| 55 | 0: Success |
| 56 | |
| 57 | 1: An unspecified error occurred |
| 58 | |
| 59 | 2: Malformed command line |
| 60 | |
| 61 | 3: Face not found (**nfdc face show** only) |
| Junxiao Shi | 6c13562 | 2016-11-21 14:30:33 +0000 | [diff] [blame] | 62 | |
| 63 | SEE ALSO |
| 64 | -------- |
| 65 | nfd(1), nfdc(1) |