eclipse / paho.mqtt.m2mqtt

Eclipse Public License 1.0
519 stars 303 forks source link

No documentation provided #50

Open HakamFostok opened 7 years ago

HakamFostok commented 7 years ago

I struggling to find some documentation for the methods, specially for the following Connect method

public byte Connect(string clientId, string username, string password, bool cleanSession, ushort keepAlivePeriod);

what is the cleanSession and keepAlivePeriod means ? Is there any documentation for the this library or not, even the Wiki is very weak.

the only documentation I found for them is /// param name="cleanSession" Clean sessione flag /// param name="keepAlivePeriod" Keep alive period which is not enough at all, for example what is the unit of the keepAlivePeriod, is it in hours, days, seconds and what is the default value for it?

Thank you in advanced.