gwm

Documentation

Index

• Constants
• type Server
  • func NewServer(s cm.ISettings) (srv *Server, err error)
  • func (srv *Server) AddForum(ar *api.Request, _ *http.Request, hrw http.ResponseWriter)
  • func (srv *Server) AddMessage(ar *api.Request, _ *http.Request, hrw http.ResponseWriter)
  • func (srv *Server) AddSection(ar *api.Request, _ *http.Request, hrw http.ResponseWriter)
  • func (srv *Server) AddThread(ar *api.Request, _ *http.Request, hrw http.ResponseWriter)
  • func (srv *Server) ApproveAndRegisterUser(ar *api.Request, _ *http.Request, hrw http.ResponseWriter)
  • func (srv *Server) BanUser(ar *api.Request, _ *http.Request, hrw http.ResponseWriter)
  • func (srv *Server) BlockIPAddress(params *json.RawMessage, _ *jrm1.ResponseMetaData) (result any, re *jrm1.RpcError)
  • func (srv *Server) ChangeEmail(ar *api.Request, _ *http.Request, hrw http.ResponseWriter)
  • func (srv *Server) ChangeForumName(ar *api.Request, _ *http.Request, hrw http.ResponseWriter)
  • func (srv *Server) ChangeForumSection(ar *api.Request, _ *http.Request, hrw http.ResponseWriter)
  • func (srv *Server) ChangeMessageText(ar *api.Request, _ *http.Request, hrw http.ResponseWriter)
  • func (srv *Server) ChangeMessageThread(ar *api.Request, _ *http.Request, hrw http.ResponseWriter)
  • func (srv *Server) ChangePassword(ar *api.Request, _ *http.Request, hrw http.ResponseWriter)
  • func (srv *Server) ChangeSectionName(ar *api.Request, _ *http.Request, hrw http.ResponseWriter)
  • func (srv *Server) ChangeSectionParent(ar *api.Request, _ *http.Request, hrw http.ResponseWriter)
  • func (srv *Server) ChangeThreadForum(ar *api.Request, _ *http.Request, hrw http.ResponseWriter)
  • func (srv *Server) ChangeThreadName(ar *api.Request, _ *http.Request, hrw http.ResponseWriter)
  • func (srv *Server) DeleteForum(ar *api.Request, _ *http.Request, hrw http.ResponseWriter)
  • func (srv *Server) DeleteMessage(ar *api.Request, _ *http.Request, hrw http.ResponseWriter)
  • func (srv *Server) DeleteSection(ar *api.Request, _ *http.Request, hrw http.ResponseWriter)
  • func (srv *Server) DeleteThread(ar *api.Request, _ *http.Request, hrw http.ResponseWriter)
  • func (srv *Server) GetForum(ar *api.Request, _ *http.Request, hrw http.ResponseWriter)
  • func (srv *Server) GetListOfAllUsers(ar *api.Request, _ *http.Request, hrw http.ResponseWriter)
  • func (srv *Server) GetListOfLoggedUsers(ar *api.Request, _ *http.Request, hrw http.ResponseWriter)
  • func (srv *Server) GetListOfRegistrationsReadyForApproval(ar *api.Request, _ *http.Request, hrw http.ResponseWriter)
  • func (srv *Server) GetListenDsnExt() (dsn string)
  • func (srv *Server) GetListenDsnInt() (dsn string)
  • func (srv *Server) GetMessage(ar *api.Request, _ *http.Request, hrw http.ResponseWriter)
  • func (srv *Server) GetSection(ar *api.Request, _ *http.Request, hrw http.ResponseWriter)
  • func (srv *Server) GetSelfRoles(ar *api.Request, _ *http.Request, hrw http.ResponseWriter)
  • func (srv *Server) GetStopChannel() *chan bool
  • func (srv *Server) GetThread(ar *api.Request, _ *http.Request, hrw http.ResponseWriter)
  • func (srv *Server) GetUserRoles(ar *api.Request, _ *http.Request, hrw http.ResponseWriter)
  • func (srv *Server) IsIPAddressBlocked(params *json.RawMessage, _ *jrm1.ResponseMetaData) (result any, re *jrm1.RpcError)
  • func (srv *Server) IsUserLoggedIn(ar *api.Request, _ *http.Request, hrw http.ResponseWriter)
  • func (srv *Server) ListForumAndThreads(ar *api.Request, _ *http.Request, hrw http.ResponseWriter)
  • func (srv *Server) ListForumAndThreadsOnPage(ar *api.Request, _ *http.Request, hrw http.ResponseWriter)
  • func (srv *Server) ListSectionsAndForums(ar *api.Request, _ *http.Request, hrw http.ResponseWriter)
  • func (srv *Server) ListThreadAndMessages(ar *api.Request, _ *http.Request, hrw http.ResponseWriter)
  • func (srv *Server) ListThreadAndMessagesOnPage(ar *api.Request, _ *http.Request, hrw http.ResponseWriter)
  • func (srv *Server) LogUserIn(ar *api.Request, _ *http.Request, hrw http.ResponseWriter)
  • func (srv *Server) LogUserOut(ar *api.Request, _ *http.Request, hrw http.ResponseWriter)
  • func (srv *Server) LogUserOutA(ar *api.Request, _ *http.Request, hrw http.ResponseWriter)
  • func (srv *Server) Ping(_ *json.RawMessage, _ *jrm1.ResponseMetaData) (result any, re *jrm1.RpcError)
  • func (srv *Server) RegisterUser(ar *api.Request, _ *http.Request, hrw http.ResponseWriter)
  • func (srv *Server) RejectRegistrationRequest(ar *api.Request, _ *http.Request, hrw http.ResponseWriter)
  • func (srv *Server) ReportStart()
  • func (srv *Server) SetUserRoleAuthor(ar *api.Request, _ *http.Request, hrw http.ResponseWriter)
  • func (srv *Server) SetUserRoleReader(ar *api.Request, _ *http.Request, hrw http.ResponseWriter)
  • func (srv *Server) SetUserRoleWriter(ar *api.Request, _ *http.Request, hrw http.ResponseWriter)
  • func (srv *Server) ShowDiagnosticData(params *json.RawMessage, _ *jrm1.ResponseMetaData) (result any, re *jrm1.RpcError)
  • func (srv *Server) Start() (err error)
  • func (srv *Server) Stop() (err error)
  • func (srv *Server) UnbanUser(ar *api.Request, _ *http.Request, hrw http.ResponseWriter)
  • func (srv *Server) UseConstructor(stn cm.ISettings) (cm.IServer, error)
  • func (srv *Server) ViewUserParameters(ar *api.Request, _ *http.Request, hrw http.ResponseWriter)

Constants

const (
	RpcErrorCode_FirewallIsDisabled = 1
	RpcErrorCode_IPAddressIsNotSet  = 2
	RpcErrorCode_BlockTimeIsNotSet  = 3
)

Codes.

const (
	RpcErrorMsg_FirewallIsDisabled = "Firewall is disabled"
	RpcErrorMsg_IPAddressIsNotSet  = "IP address is not set"
	RpcErrorMsg_BlockTimeIsNotSet  = "Block time is not set"
)

Messages.

const (
	// ACM.
	ApiFunctionName_RegisterUser                           = "registerUser"
	ApiFunctionName_GetListOfRegistrationsReadyForApproval = "getListOfRegistrationsReadyForApproval"
	ApiFunctionName_RejectRegistrationRequest              = "rejectRegistrationRequest"
	ApiFunctionName_ApproveAndRegisterUser                 = "approveAndRegisterUser"
	ApiFunctionName_LogUserIn                              = "logUserIn"
	ApiFunctionName_LogUserOut                             = "logUserOut"
	ApiFunctionName_LogUserOutA                            = "logUserOutA"
	ApiFunctionName_GetListOfLoggedUsers                   = "getListOfLoggedUsers"
	ApiFunctionName_IsUserLoggedIn                         = "isUserLoggedIn"
	ApiFunctionName_ChangePassword                         = "changePassword"
	ApiFunctionName_ChangeEmail                            = "changeEmail"
	ApiFunctionName_GetListOfAllUsers                      = "getListOfAllUsers"
	ApiFunctionName_GetUserRoles                           = "getUserRoles"
	ApiFunctionName_ViewUserParameters                     = "viewUserParameters"
	ApiFunctionName_SetUserRoleAuthor                      = "setUserRoleAuthor"
	ApiFunctionName_SetUserRoleWriter                      = "setUserRoleWriter"
	ApiFunctionName_SetUserRoleReader                      = "setUserRoleReader"
	ApiFunctionName_GetSelfRoles                           = "getSelfRoles"
	ApiFunctionName_BanUser                                = "banUser"
	ApiFunctionName_UnbanUser                              = "unbanUser"

	// MM.
	ApiFunctionName_AddSection                  = "addSection"
	ApiFunctionName_ChangeSectionName           = "changeSectionName"
	ApiFunctionName_ChangeSectionParent         = "changeSectionParent"
	ApiFunctionName_GetSection                  = "getSection"
	ApiFunctionName_DeleteSection               = "deleteSection"
	ApiFunctionName_AddForum                    = "addForum"
	ApiFunctionName_ChangeForumName             = "changeForumName"
	ApiFunctionName_ChangeForumSection          = "changeForumSection"
	ApiFunctionName_GetForum                    = "getForum"
	ApiFunctionName_DeleteForum                 = "deleteForum"
	ApiFunctionName_AddThread                   = "addThread"
	ApiFunctionName_ChangeThreadName            = "changeThreadName"
	ApiFunctionName_ChangeThreadForum           = "changeThreadForum"
	ApiFunctionName_GetThread                   = "getThread"
	ApiFunctionName_DeleteThread                = "deleteThread"
	ApiFunctionName_AddMessage                  = "addMessage"
	ApiFunctionName_ChangeMessageText           = "changeMessageText"
	ApiFunctionName_ChangeMessageThread         = "changeMessageThread"
	ApiFunctionName_GetMessage                  = "getMessage"
	ApiFunctionName_DeleteMessage               = "deleteMessage"
	ApiFunctionName_ListThreadAndMessages       = "listThreadAndMessages"
	ApiFunctionName_ListThreadAndMessagesOnPage = "listThreadAndMessagesOnPage"
	ApiFunctionName_ListForumAndThreads         = "listForumAndThreads"
	ApiFunctionName_ListForumAndThreadsOnPage   = "listForumAndThreadsOnPage"
	ApiFunctionName_ListSectionsAndForums       = "listSectionsAndForums"
)

const (
	ErrFUnknownRpcErrorCode = "unknown RPC error code: %v"
	ErrTypeCast             = "type cast error"
)

const ErrUrlIsTooShort = "URL is too short"

Types

type Server

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

func NewServer

func NewServer(s cm.ISettings) (srv *Server, err error)

func (*Server) AddForum

func (srv *Server) AddForum(ar *api.Request, _ *http.Request, hrw http.ResponseWriter)

func (*Server) AddMessage

func (srv *Server) AddMessage(ar *api.Request, _ *http.Request, hrw http.ResponseWriter)

func (*Server) AddSection

func (srv *Server) AddSection(ar *api.Request, _ *http.Request, hrw http.ResponseWriter)

func (*Server) AddThread

func (srv *Server) AddThread(ar *api.Request, _ *http.Request, hrw http.ResponseWriter)

func (*Server) ApproveAndRegisterUser

func (srv *Server) ApproveAndRegisterUser(ar *api.Request, _ *http.Request, hrw http.ResponseWriter)

func (*Server) BanUser

func (srv *Server) BanUser(ar *api.Request, _ *http.Request, hrw http.ResponseWriter)

func (*Server) BlockIPAddress

func (srv *Server) BlockIPAddress(params *json.RawMessage, _ *jrm1.ResponseMetaData) (result any, re *jrm1.RpcError)

func (*Server) ChangeEmail

func (srv *Server) ChangeEmail(ar *api.Request, _ *http.Request, hrw http.ResponseWriter)

func (*Server) ChangeForumName

func (srv *Server) ChangeForumName(ar *api.Request, _ *http.Request, hrw http.ResponseWriter)

func (*Server) ChangeForumSection

func (srv *Server) ChangeForumSection(ar *api.Request, _ *http.Request, hrw http.ResponseWriter)

func (*Server) ChangeMessageText

func (srv *Server) ChangeMessageText(ar *api.Request, _ *http.Request, hrw http.ResponseWriter)

func (*Server) ChangeMessageThread

func (srv *Server) ChangeMessageThread(ar *api.Request, _ *http.Request, hrw http.ResponseWriter)

func (*Server) ChangePassword

func (srv *Server) ChangePassword(ar *api.Request, _ *http.Request, hrw http.ResponseWriter)

func (*Server) ChangeSectionName

func (srv *Server) ChangeSectionName(ar *api.Request, _ *http.Request, hrw http.ResponseWriter)

func (*Server) ChangeSectionParent

func (srv *Server) ChangeSectionParent(ar *api.Request, _ *http.Request, hrw http.ResponseWriter)

func (*Server) ChangeThreadForum

func (srv *Server) ChangeThreadForum(ar *api.Request, _ *http.Request, hrw http.ResponseWriter)

func (*Server) ChangeThreadName

func (srv *Server) ChangeThreadName(ar *api.Request, _ *http.Request, hrw http.ResponseWriter)

func (*Server) DeleteForum

func (srv *Server) DeleteForum(ar *api.Request, _ *http.Request, hrw http.ResponseWriter)

func (*Server) DeleteMessage

func (srv *Server) DeleteMessage(ar *api.Request, _ *http.Request, hrw http.ResponseWriter)

func (*Server) DeleteSection

func (srv *Server) DeleteSection(ar *api.Request, _ *http.Request, hrw http.ResponseWriter)

func (*Server) DeleteThread

func (srv *Server) DeleteThread(ar *api.Request, _ *http.Request, hrw http.ResponseWriter)

func (*Server) GetForum

func (srv *Server) GetForum(ar *api.Request, _ *http.Request, hrw http.ResponseWriter)

func (*Server) GetListOfAllUsers

func (srv *Server) GetListOfAllUsers(ar *api.Request, _ *http.Request, hrw http.ResponseWriter)

func (*Server) GetListOfLoggedUsers

func (srv *Server) GetListOfLoggedUsers(ar *api.Request, _ *http.Request, hrw http.ResponseWriter)

func (*Server) GetListOfRegistrationsReadyForApproval

func (srv *Server) GetListOfRegistrationsReadyForApproval(ar *api.Request, _ *http.Request, hrw http.ResponseWriter)

func (*Server) GetListenDsnExt

func (srv *Server) GetListenDsnExt() (dsn string)

func (*Server) GetListenDsnInt

func (srv *Server) GetListenDsnInt() (dsn string)

func (*Server) GetMessage

func (srv *Server) GetMessage(ar *api.Request, _ *http.Request, hrw http.ResponseWriter)

func (*Server) GetSection

func (srv *Server) GetSection(ar *api.Request, _ *http.Request, hrw http.ResponseWriter)

func (*Server) GetSelfRoles

func (srv *Server) GetSelfRoles(ar *api.Request, _ *http.Request, hrw http.ResponseWriter)

GetSelfRoles is a normal version of 'GetSelfRoles' RPC request for public usage. For internal purposes, use its internal variant – 'getSelfRoles'.

func (*Server) GetStopChannel

func (srv *Server) GetStopChannel() *chan bool

func (*Server) GetThread

func (srv *Server) GetThread(ar *api.Request, _ *http.Request, hrw http.ResponseWriter)

func (*Server) GetUserRoles

func (srv *Server) GetUserRoles(ar *api.Request, _ *http.Request, hrw http.ResponseWriter)

func (*Server) IsIPAddressBlocked

func (srv *Server) IsIPAddressBlocked(params *json.RawMessage, _ *jrm1.ResponseMetaData) (result any, re *jrm1.RpcError)

func (*Server) IsUserLoggedIn

func (srv *Server) IsUserLoggedIn(ar *api.Request, _ *http.Request, hrw http.ResponseWriter)

func (*Server) ListForumAndThreads

func (srv *Server) ListForumAndThreads(ar *api.Request, _ *http.Request, hrw http.ResponseWriter)

func (*Server) ListForumAndThreadsOnPage

func (srv *Server) ListForumAndThreadsOnPage(ar *api.Request, _ *http.Request, hrw http.ResponseWriter)

func (*Server) ListSectionsAndForums

func (srv *Server) ListSectionsAndForums(ar *api.Request, _ *http.Request, hrw http.ResponseWriter)

func (*Server) ListThreadAndMessages

func (srv *Server) ListThreadAndMessages(ar *api.Request, _ *http.Request, hrw http.ResponseWriter)

func (*Server) ListThreadAndMessagesOnPage

func (srv *Server) ListThreadAndMessagesOnPage(ar *api.Request, _ *http.Request, hrw http.ResponseWriter)

func (*Server) LogUserIn

func (srv *Server) LogUserIn(ar *api.Request, _ *http.Request, hrw http.ResponseWriter)

func (*Server) LogUserOut

func (srv *Server) LogUserOut(ar *api.Request, _ *http.Request, hrw http.ResponseWriter)

func (*Server) LogUserOutA

func (srv *Server) LogUserOutA(ar *api.Request, _ *http.Request, hrw http.ResponseWriter)

func (*Server) Ping

func (srv *Server) Ping(_ *json.RawMessage, _ *jrm1.ResponseMetaData) (result any, re *jrm1.RpcError)

func (*Server) RegisterUser

func (srv *Server) RegisterUser(ar *api.Request, _ *http.Request, hrw http.ResponseWriter)

func (*Server) RejectRegistrationRequest

func (srv *Server) RejectRegistrationRequest(ar *api.Request, _ *http.Request, hrw http.ResponseWriter)

func (*Server) ReportStart

func (srv *Server) ReportStart()

func (*Server) SetUserRoleAuthor

func (srv *Server) SetUserRoleAuthor(ar *api.Request, _ *http.Request, hrw http.ResponseWriter)

func (*Server) SetUserRoleReader

func (srv *Server) SetUserRoleReader(ar *api.Request, _ *http.Request, hrw http.ResponseWriter)

func (*Server) SetUserRoleWriter

func (srv *Server) SetUserRoleWriter(ar *api.Request, _ *http.Request, hrw http.ResponseWriter)

func (*Server) ShowDiagnosticData

func (srv *Server) ShowDiagnosticData(params *json.RawMessage, _ *jrm1.ResponseMetaData) (result any, re *jrm1.RpcError)

func (*Server) Start

func (srv *Server) Start() (err error)

func (*Server) Stop

func (srv *Server) Stop() (err error)

func (*Server) UnbanUser

func (srv *Server) UnbanUser(ar *api.Request, _ *http.Request, hrw http.ResponseWriter)

func (*Server) UseConstructor

func (srv *Server) UseConstructor(stn cm.ISettings) (cm.IServer, error)

func (*Server) ViewUserParameters

func (srv *Server) ViewUserParameters(ar *api.Request, _ *http.Request, hrw http.ResponseWriter)