Project

General

Profile

Actions

Feature #3173

closed

Developer Guide: Face=LinkService+Transport and GenericLinkService

Added by Junxiao Shi over 8 years ago. Updated about 8 years ago.

Status:
Closed
Priority:
Normal
Assignee:
Category:
Docs
Target version:
Start date:
Due date:
% Done:

100%

Estimated time:
6.00 h

Description

Update NFD Developer Guide to describe:

  • Face refactoring toward LinkService+Transport structure
  • permanent faces
  • GenericLinkService

Related issues 7 (0 open7 closed)

Related to NFD - Task #3172: Refactor Face: completionClosedJunxiao Shi

Actions
Related to NFD - Feature #2222: NDNLPv2 design: link serviceClosedJunxiao Shi

Actions
Related to NFD - Task #2491: Design permanent facesClosedJunxiao Shi

Actions
Related to NFD - Task #2450: Make log messages more uniform across all face typesClosedDavide Pesavento

Actions
Blocks NFD - Task #3395: Developer Guide: Transport detailsClosedEric Newberry

Actions
Blocks NFD - Task #3396: Developer Guide: LinkServiceClosedEric Newberry

Actions
Blocks NFD - Task #3397: Developer Guide: Face system organizationClosedEric Newberry

Actions
Actions #1

Updated by Junxiao Shi over 8 years ago

  • Related to Task #3172: Refactor Face: completion added
Actions #2

Updated by Junxiao Shi over 8 years ago

Actions #3

Updated by Junxiao Shi over 8 years ago

  • Subject changed from Developer Guide: Face=LinkService+Transport to Developer Guide: Face=LinkService+Transport and GenericLinkService
  • Description updated (diff)
  • Assignee set to Junxiao Shi

I'll write this section because I'm the primary designer of these features.

Implementors should contribute their experiences in different transports and link service features.

Actions #4

Updated by Junxiao Shi over 8 years ago

  • Description updated (diff)
Actions #5

Updated by Junxiao Shi over 8 years ago

  • Related to Task #2491: Design permanent faces added
Actions #6

Updated by Junxiao Shi over 8 years ago

  • Related to Task #2450: Make log messages more uniform across all face types added
Actions #7

Updated by Junxiao Shi over 8 years ago

  • Status changed from New to In Progress
Actions #8

Updated by Junxiao Shi over 8 years ago

  • % Done changed from 0 to 20
Actions #9

Updated by Junxiao Shi over 8 years ago

  • % Done changed from 20 to 40
Actions #10

Updated by Alex Afanasyev about 8 years ago

  • Description updated (diff)
Actions #11

Updated by Alex Afanasyev about 8 years ago

  • Assignee changed from Junxiao Shi to Eric Newberry
Actions #12

Updated by Junxiao Shi about 8 years ago

  • Assignee changed from Eric Newberry to Junxiao Shi

As I agreed in 20160106 conference call, I'll fill in the "static properties" paragraphs.

After that, this will be re-assigned to Eric for adding more details.

Actions #13

Updated by Junxiao Shi about 8 years ago

  • Blocks Task #3395: Developer Guide: Transport details added
Actions #14

Updated by Junxiao Shi about 8 years ago

  • Blocks Task #3396: Developer Guide: LinkService added
Actions #15

Updated by Junxiao Shi about 8 years ago

  • Blocks Task #3397: Developer Guide: Face system organization added
Actions #16

Updated by Junxiao Shi about 8 years ago

  • Description updated (diff)
  • Status changed from In Progress to Closed
  • % Done changed from 40 to 100

I've completed my edits. Eric's tasks are split to #3395 #3396 #3397.

From Alex's suggestions:

order of transports should be: internal, unix, ethernet, udp unicast, udp multicast, tcp, websocket, dummy

This is already completed, except that DummyTransport is moved to "testing" section.

Remove references to old face system
Finalize description of transports (udp unicast, udp multicast, ethernet, internal, dummy)
Generic link service description.
face system (2.3): ProtocolFactory, Channel, workflow(?)
remove old face system (section 3), moving elements to section 2: Protocol Factory, Channel

These are moved to one of the follow-up tasks.

Maybe we should not mention “planned” features and services

I disagree with this. Roadmap can be included in devguide.

“developing a new link service” section (2.3.3). Should be called “Extending NFD Face System”

No. Both LinkService and Transport can be extended, and they are in different sections.

moving elements to section 2: FaceUri

This is already covered in sections of each Transport. It's intentional not to have a big table, because a table with just the FaceUri but not other properties is incomplete.
Such a table already exists in FaceMgmt page and there's no reason to duplicate it.

tables (4.2, network regions table). We may need to add more details and references

This is unrelated to face system. Alex may reopen #3159 with a detailed suggestion on what is to be added.

Actions

Also available in: Atom PDF