| 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 | f0dfb33 | 2017-02-02 05:32:25 +0000 | [diff] [blame] | 7 | | nfdc face show <FACEID> |
| Junxiao Shi | 1d7fef5 | 2017-02-02 05:33:14 +0000 | [diff] [blame] | 8 | | nfdc face create [remote] <FACEURI> [[persistency] <PERSISTENCY>] |
| Junxiao Shi | f0dfb33 | 2017-02-02 05:32:25 +0000 | [diff] [blame] | 9 | | nfdc destroy <FACEID|FACEURI> |
| Junxiao Shi | 1d7fef5 | 2017-02-02 05:33:14 +0000 | [diff] [blame] | 10 | | nfdc channel [list] |
| Junxiao Shi | 6c13562 | 2016-11-21 14:30:33 +0000 | [diff] [blame] | 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 | 1d7fef5 | 2017-02-02 05:33:14 +0000 | [diff] [blame] | 23 | The **nfdc face create** command creates a unicast UDP or TCP face. |
| Junxiao Shi | 6c13562 | 2016-11-21 14:30:33 +0000 | [diff] [blame] | 24 | |
| 25 | The **nfdc destroy** command destroys an existing face. |
| 26 | It has no effect if the specified face does not exist. |
| 27 | |
| Junxiao Shi | 1d7fef5 | 2017-02-02 05:33:14 +0000 | [diff] [blame] | 28 | The **nfdc channel list** command shows a list of channels. |
| 29 | Channels are listening sockets that can accept incoming connections and create new faces. |
| 30 | |
| Junxiao Shi | 6c13562 | 2016-11-21 14:30:33 +0000 | [diff] [blame] | 31 | OPTIONS |
| 32 | ------- |
| Junxiao Shi | f0dfb33 | 2017-02-02 05:32:25 +0000 | [diff] [blame] | 33 | <FACEID> |
| Junxiao Shi | 1f481fa | 2017-01-26 15:14:43 +0000 | [diff] [blame] | 34 | Numerical identifier of the face. |
| Junxiao Shi | 1d7fef5 | 2017-02-02 05:33:14 +0000 | [diff] [blame] | 35 | It is displayed in the output of **nfdc face list** and **nfdc face create** commands. |
| Junxiao Shi | 1f481fa | 2017-01-26 15:14:43 +0000 | [diff] [blame] | 36 | |
| Junxiao Shi | f0dfb33 | 2017-02-02 05:32:25 +0000 | [diff] [blame] | 37 | <FACEURI> |
| Junxiao Shi | 6c13562 | 2016-11-21 14:30:33 +0000 | [diff] [blame] | 38 | An URI representing the remote endpoint of a face. |
| 39 | Its syntax is: |
| 40 | |
| 41 | - udp[4|6]://<IP-or-host>[:<port>] |
| 42 | - tcp[4|6]://<IP-or-host>[:<port>] |
| 43 | |
| 44 | When a hostname is specified, a DNS query is used to obtain the IP address. |
| 45 | |
| Junxiao Shi | 1d7fef5 | 2017-02-02 05:33:14 +0000 | [diff] [blame] | 46 | <PERSISTENCY> |
| 47 | Either "persistent" or "permanent". |
| 48 | A "persistent" face (the default) is closed when a socket error occurs. |
| 49 | A "permanent" face survives socket errors, and is closed only with a **nfdc destroy** command. |
| 50 | |
| Junxiao Shi | 1f481fa | 2017-01-26 15:14:43 +0000 | [diff] [blame] | 51 | EXIT CODES |
| 52 | ---------- |
| 53 | |
| 54 | 0: Success |
| 55 | |
| 56 | 1: An unspecified error occurred |
| 57 | |
| 58 | 2: Malformed command line |
| 59 | |
| 60 | 3: Face not found (**nfdc face show** only) |
| Junxiao Shi | 6c13562 | 2016-11-21 14:30:33 +0000 | [diff] [blame] | 61 | |
| Junxiao Shi | 1d7fef5 | 2017-02-02 05:33:14 +0000 | [diff] [blame] | 62 | 4: FaceUri canonization failed (**nfdc face create** only) |
| 63 | |
| Junxiao Shi | 6c13562 | 2016-11-21 14:30:33 +0000 | [diff] [blame] | 64 | SEE ALSO |
| 65 | -------- |
| 66 | nfd(1), nfdc(1) |