Review public API

[marcfrei]

Going through lib/include/scion/scion.h, we should discuss the following renamings:

• scion_path_get_hops > scion_path_get_numhops?
• scion_interface_id > scion_ifid? Matches better with scion_ia
• scion_path_interface > scion_hop?
• scion_fetch_paths > scion_path_collection_fetch?
• scion_print_addr > scion_addr_print or scion_host_addr_print?
• scion_scmp_echo_free_internal > scion_scmp_echo_free?

[koflin]

scion_path_get_hops > scion_path_get_numhops?

agreed

scion_interface_id > scion_ifid? Matches better with scion_ia

agreed

scion_path_interface > scion_hop?

Isn't the definition of a hop the connection between two interfaces? In this case the struct represents an interface on the path, so I think hop would not be fitting.

scion_fetch_paths > scion_path_collection_fetch?

agreed

scion_print_addr > scion_addr_print or scion_host_addr_print?

I like scion_addr_print.

scion_scmp_echo_free_internal > scion_scmp_echo_free?

At the moment the convention in the codebase is that _free_internal is the suffix for functions that do not free the pointer passed, but only its internal members. However, I also see that this is just something that we could document and use the suffix _free for all freeing functions regardless of whether they free the passed pointer itself. What do you think?