notice

Documentation

Index

• Constants
• Variables
• func Clear()
• func CloseClient(user string, clientID string) bool
• func CloseMessage(user string, types ...string)
• func Default() *userNotices
• func NewUserNotices(debug bool) *userNotices
• func OnClose(fn ...func(user string)) *userNotices
• func OnOpen(fn ...func(user string)) *userNotices
• func OpenClient(user string) string
• func OpenMessage(user string, types ...string)
• func Recv(user string, clientID string) <-chan *Message
• func RecvJSON(user string, clientID string) ([]byte, error)
• func RecvXML(user string, clientID string) ([]byte, error)
• func Send(user string, message *Message) error
• func SetDebug(on bool)
• func Stdout(message *Message)
• type Control
  • func (c *Control) Exited() *Control
  • func (c *Control) IsExited() bool
  • func (c *Control) ListenContextAndTimeout(ctx context.Context, timeouts ...time.Duration) *Control
• type HTTPNoticerConfig
• type IsExited
  • func NewControlWithContext(ctx context.Context, timeout time.Duration) IsExited
• type Message
  • func NewMessage() *Message
  • func NewMessageWithValue(typ string, title string, content interface{}, status ...int) *Message
  • func (m *Message) CalcPercent() *Message
  • func (m *Message) SetClientID(clientID string) *Message
  • func (m *Message) SetContent(content interface{}) *Message
  • func (m *Message) SetID(id interface{}) *Message
  • func (m *Message) SetMode(mode string) *Message
  • func (m *Message) SetProgress(progress *Progress) *Message
  • func (m *Message) SetProgressValue(finish int64, total int64) *Message
  • func (m *Message) SetStatus(status int) *Message
  • func (m *Message) SetTitle(title string) *Message
  • func (m *Message) SetType(t string) *Message
• type Notice
  • func NewNotice() *Notice
  • func (a *Notice) CloseClient(clientID string)
  • func (a *Notice) CountClient() int
  • func (a *Notice) OpenClient(clientID string)
• type Noticer
  • func NewNoticer(ctx context.Context, config *HTTPNoticerConfig) Noticer
• type OnlineUser
  • func NewOnlineUser() *OnlineUser
• type Progress
  • func NewProgress() *Progress
  • func (p *Progress) CalcPercent() *Progress
  • func (p *Progress) IsExited() bool
  • func (p *Progress) SetControl(control IsExited) *Progress

Constants

const (
	Succeed         = 1
	Failed          = 0
	Unauthenticated = -1
	Forbid          = -2
)

Variables

var (
	ErrUserNotOnline     = errors.New(`通知错误：用户不在线`)
	ErrMsgTypeNotAccept  = errors.New(`通知错误：不接受这种消息类型`)
	ErrClientIDNotOnline = errors.New(`通知错误：ClientID不在线`)
	ErrForcedExit        = errors.New(`Forced exit`)
)

Functions

func Clear

func Clear()

func CloseClient

func CloseClient(user string, clientID string) bool

func CloseMessage

func CloseMessage(user string, types ...string)

func Default

func Default() *userNotices

func NewUserNotices

func NewUserNotices(debug bool) *userNotices

func OnClose

func OnClose(fn ...func(user string)) *userNotices

func OnOpen

func OnOpen(fn ...func(user string)) *userNotices

func OpenClient

func OpenClient(user string) string

func OpenMessage

func OpenMessage(user string, types ...string)

func Recv

func Recv(user string, clientID string) <-chan *Message

func RecvJSON

func RecvJSON(user string, clientID string) ([]byte, error)

func RecvXML

func RecvXML(user string, clientID string) ([]byte, error)

func Send

func Send(user string, message *Message) error

func SetDebug

func SetDebug(on bool)

func Stdout

func Stdout(message *Message)

Types

type Control

type Control struct {
	// contains filtered or unexported fields
}

func (*Control) Exited

func (c *Control) Exited() *Control

func (*Control) IsExited

func (c *Control) IsExited() bool

func (*Control) ListenContextAndTimeout

func (c *Control) ListenContextAndTimeout(ctx context.Context, timeouts ...time.Duration) *Control

type HTTPNoticerConfig

type HTTPNoticerConfig struct {
	User     string
	Type     string
	ClientID string
	ID       interface{}
	IsExited IsExited
	Timeout  time.Duration
	Mode     string
}

type IsExited

type IsExited interface {
	IsExited() bool
}

func NewControlWithContext

func NewControlWithContext(ctx context.Context, timeout time.Duration) IsExited

type Message

type Message struct {
	ClientID string      `json:"client_id" xml:"client_id"`
	ID       interface{} `json:"id" xml:"id"`
	Type     string      `json:"type" xml:"type"`
	Title    string      `json:"title" xml:"title"`
	Status   int         `json:"status" xml:"status"`
	Content  interface{} `json:"content" xml:"content"`
	Mode     string      `json:"mode" xml:"mode"` //显示模式：notify/element/modal
	Progress *Progress   `json:"progress" xml:"progress"`
}

func NewMessage

func NewMessage() *Message

func NewMessageWithValue

func NewMessageWithValue(typ string, title string, content interface{}, status ...int) *Message

func (*Message) CalcPercent

func (m *Message) CalcPercent() *Message

func (*Message) SetClientID

func (m *Message) SetClientID(clientID string) *Message

func (*Message) SetContent

func (m *Message) SetContent(content interface{}) *Message

func (*Message) SetID

func (m *Message) SetID(id interface{}) *Message

func (*Message) SetMode

func (m *Message) SetMode(mode string) *Message

func (*Message) SetProgress

func (m *Message) SetProgress(progress *Progress) *Message

func (*Message) SetProgressValue

func (m *Message) SetProgressValue(finish int64, total int64) *Message

func (*Message) SetStatus

func (m *Message) SetStatus(status int) *Message

func (*Message) SetTitle

func (m *Message) SetTitle(title string) *Message

func (*Message) SetType

func (m *Message) SetType(t string) *Message

type Notice

type Notice struct {
	Types    map[string]bool
	Messages map[string]chan *Message `json:"-" xml:"-"`
}

func NewNotice

func NewNotice() *Notice

func (*Notice) CloseClient

func (a *Notice) CloseClient(clientID string)

func (*Notice) CountClient

func (a *Notice) CountClient() int

func (*Notice) OpenClient

func (a *Notice) OpenClient(clientID string)

type Noticer

type Noticer func(message interface{}, statusCode int, progress ...*Progress) error

var (
	// DefaultNoticer 默认noticer
	// statusCode > 0 为成功；否则为失败
	DefaultNoticer Noticer = func(message interface{}, statusCode int, progs ...*Progress) error {
		if len(progs) > 0 && progs[0] != nil {
			message = `[ ` + tplfunc.NumberFormat(progs[0].CalcPercent().Percent, 2) + `% ] ` + fmt.Sprint(message)
		}
		if statusCode > 0 {
			log.Info(message)
		} else {
			log.Error(message)
		}
		return nil
	}

	CustomOutputNoticer func(wOut io.Writer, wErr io.Writer) Noticer = func(wOut io.Writer, wErr io.Writer) Noticer {
		return func(message interface{}, statusCode int, progs ...*Progress) error {
			if len(progs) > 0 && progs[0] != nil {
				message = `[ ` + tplfunc.NumberFormat(progs[0].CalcPercent().Percent, 2) + `% ] ` + fmt.Sprint(message)
			}
			if statusCode > 0 {
				fmt.Fprintln(wOut, message)
			} else {
				fmt.Fprintln(wErr, message)
			}
			return nil
		}
	}
)

func NewNoticer

func NewNoticer(ctx context.Context, config *HTTPNoticerConfig) Noticer

type OnlineUser

type OnlineUser struct {
	*Notice
}

func NewOnlineUser

func NewOnlineUser() *OnlineUser

type Progress

type Progress struct {
	Total    int64   `json:"total" xml:"total"`
	Finish   int64   `json:"finish" xml:"finish"`
	Percent  float64 `json:"percent" xml:"percent"`
	Complete bool    `json:"complete" xml:"complete"`
	// contains filtered or unexported fields
}

func NewProgress

func NewProgress() *Progress

func (*Progress) CalcPercent

func (p *Progress) CalcPercent() *Progress

func (*Progress) IsExited

func (p *Progress) IsExited() bool

func (*Progress) SetControl

func (p *Progress) SetControl(control IsExited) *Progress