Gitiles
Code Review Sign In
gerrit.named-data.net / NFD / 26cbdbd904a2bbfcaa0228cfe30e454ed59c3a27 / . / docs / manpages / nfdc-face.rst
blob: 46d0ef5efe14ca523716325ba18353e80497ae3d [file] [log] [blame]
Junxiao Shi6c135622016-11-21 14:30:33 +0000[diff] [blame]1nfdc-face
2=========
3
4SYNOPSIS
5--------
6| nfdc face [list]
Junxiao Shif0dfb332017-02-02 05:32:25 +0000[diff] [blame]7| nfdc face show <FACEID>
Junxiao Shi1d7fef52017-02-02 05:33:14 +0000[diff] [blame]8| nfdc face create [remote] <FACEURI> [[persistency] <PERSISTENCY>]
Junxiao Shi05dd4442017-02-06 22:50:07 +0000[diff] [blame]9| nfdc face destroy <FACEID|FACEURI>
Junxiao Shi1d7fef52017-02-02 05:33:14 +0000[diff] [blame]10| nfdc channel [list]
Junxiao Shi6c135622016-11-21 14:30:33 +0000[diff] [blame]11
12DESCRIPTION
13-----------
14In NFD, a face is the generalization of network interface.
15It could be a physical network interface to communicate on a physical link,
16an overlay communication channel between NFD and a remote node,
17or an inter-process communication channel between NFD and a local application.
18
19The **nfdc face list** command shows a list of faces, their properties, and statistics.
20
Junxiao Shi1f481fa2017-01-26 15:14:43 +0000[diff] [blame]21The **nfdc face show** command shows properties and statistics of one specific face.
22
Junxiao Shi1d7fef52017-02-02 05:33:14 +0000[diff] [blame]23The **nfdc face create** command creates a unicast UDP or TCP face.
Junxiao Shi6c135622016-11-21 14:30:33 +0000[diff] [blame]24
Junxiao Shi05dd4442017-02-06 22:50:07 +0000[diff] [blame]25The **nfdc face destroy** command destroys an existing face.
Junxiao Shi6c135622016-11-21 14:30:33 +0000[diff] [blame]26
Junxiao Shi1d7fef52017-02-02 05:33:14 +0000[diff] [blame]27The **nfdc channel list** command shows a list of channels.
28Channels are listening sockets that can accept incoming connections and create new faces.
29
Junxiao Shi6c135622016-11-21 14:30:33 +0000[diff] [blame]30OPTIONS
31-------
Junxiao Shif0dfb332017-02-02 05:32:25 +0000[diff] [blame]32<FACEID>
Junxiao Shi1f481fa2017-01-26 15:14:43 +0000[diff] [blame]33 Numerical identifier of the face.
Junxiao Shi1d7fef52017-02-02 05:33:14 +0000[diff] [blame]34 It is displayed in the output of **nfdc face list** and **nfdc face create** commands.
Junxiao Shi1f481fa2017-01-26 15:14:43 +0000[diff] [blame]35
Junxiao Shif0dfb332017-02-02 05:32:25 +0000[diff] [blame]36<FACEURI>
Junxiao Shi6c135622016-11-21 14:30:33 +0000[diff] [blame]37 An URI representing the remote endpoint of a face.
38 Its syntax is:
39
40 - udp[4|6]://<IP-or-host>[:<port>]
41 - tcp[4|6]://<IP-or-host>[:<port>]
42
43 When a hostname is specified, a DNS query is used to obtain the IP address.
44
Junxiao Shi1d7fef52017-02-02 05:33:14 +0000[diff] [blame]45<PERSISTENCY>
46 Either "persistent" or "permanent".
47 A "persistent" face (the default) is closed when a socket error occurs.
48 A "permanent" face survives socket errors, and is closed only with a **nfdc destroy** command.
49
Junxiao Shi1f481fa2017-01-26 15:14:43 +0000[diff] [blame]50EXIT CODES
51----------
52
530: Success
54
551: An unspecified error occurred
56
572: Malformed command line
58
Junxiao Shi05dd4442017-02-06 22:50:07 +0000[diff] [blame]593: Face not found (**nfdc face show** and **nfdc face destroy** only)
Junxiao Shi6c135622016-11-21 14:30:33 +0000[diff] [blame]60
Junxiao Shi05dd4442017-02-06 22:50:07 +0000[diff] [blame]614: FaceUri canonization failed (**nfdc face create** and **nfdc face destroy** only)
62
635: Ambiguous: multiple matching faces are found (**nfdc face destroy** only)
Junxiao Shi1d7fef52017-02-02 05:33:14 +0000[diff] [blame]64
Junxiao Shi6c135622016-11-21 14:30:33 +0000[diff] [blame]65SEE ALSO
66--------
67nfd(1), nfdc(1)