[incubator-inlong] 02/09: Add license and comments

[go...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

gosonzhang pushed a commit to branch INLONG-25
in repository https://gitbox.apache.org/repos/asf/incubator-inlong.git

commit 845de0bb31725c0cbba509eefdf31458331edd88
Author: Zijie Lu <ws...@gmail.com>
AuthorDate: Thu Jun 3 17:48:44 2021 +0800

    Add license and comments
    
    Signed-off-by: Zijie Lu <ws...@gmail.com>
---
 tubemq-client-twins/tubemq-client-go/util/util.go | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)

diff --git a/tubemq-client-twins/tubemq-client-go/util/util.go b/tubemq-client-twins/tubemq-client-go/util/util.go
index 77422ac..1157d39 100644
--- a/tubemq-client-twins/tubemq-client-go/util/util.go
+++ b/tubemq-client-twins/tubemq-client-go/util/util.go
@@ -1,11 +1,31 @@
+/**
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ * <p>
+ * http://www.apache.org/licenses/LICENSE-2.0
+ * <p>
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+// package util defines the constants and helper functions.
 package util
 
 import (
 	"net"
 )
 
+// InValidValue of TubeMQ config.
 var InvalidValue = int64(-2)
 
+// GetLocalHost returns the local host name.
 func GetLocalHost() string {
 	ifaces, err := net.Interfaces()
 	if err != nil {
@@ -43,10 +63,12 @@ func GetLocalHost() string {
 	return ""
 }
 
+// GenBrokerAuthenticateToken generates the broker authenticate token.
 func GenBrokerAuthenticateToken(username string, password string) string {
 	return ""
 }
 
+// GenMasterAuthenticateToken generates the master authenticate token.
 func GenMasterAuthenticateToken(username string, password string) string {
 	return ""
 }