User Tools

Site Tools


api_naming_convention_-_primitive_service_project

Primitive Service contains lots of individual services. API naming convention is required to maintain the consistency as follows.

Public C API

For Each Service, put the prefix to represent its service and distinguish from others.

Example

ESResult ESinitEnrollee(ESEventCallback)

Public C++ API

Use the naming space as OIC::Service and place whole class with same level following general C++ practice.

Example

 OIC::Service::EasySetup, OIC::Service::EasySetupDeviceInfo

Class name or method name does not requires to have the specific prefix as like C API.

Public Java API

Specify each category as multiple level of depths. Put the prefix as like “iotivity.service”.

Under the specific service, you can place the additional package to specify the feature.

Example

 org.iotivity.service.easysetup.mediator.EasySetupService

Common class for specific service can be placed under iotivity.service.easysetup or Common class for whole services can be placed under iotivity.service.

 org.iotivity.service.RcsValue
api_naming_convention_-_primitive_service_project.txt · Last modified: 2016/04/05 10:15 by Uze Choi