/*
   Copyright 2020 XiaochengTech

   Licensed 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

       http://www.apache.org/licenses/LICENSE-2.0

   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 connections

import (
	"net"
	"time"
)

// 单一连接的通用接口
type Connection interface {
	// 操作接口
	Connect(addr string) (err error)     // 连接
	Read() (buf []byte, err error)       // 读取信息
	Write(buf []byte) (n int, err error) // 写入信息
	Close()                              // 关闭连接
	SetConnectTimeout(d time.Duration)   // 设置连接超时
	SetReadTimeout(d time.Duration)      // 设置读超时
	SetWriteTimeout(d time.Duration)     // 设置写超时
	// 信息接口
	Identifier() string // 唯一标志
	IsPassive() bool    // 是否是被动连接/主动连接
	Conn() net.Conn     // 底层连接
	IsClosed() bool     // 是否已经关闭
}