Documentation
¶
Overview ¶
Package http_static contains generated bindings for API file http_static.api.
Contents: - 4 messages
Index ¶
- Constants
- func AllMessages() []api.Message
- type HTTPStaticEnableV4
- func (*HTTPStaticEnableV4) GetCrcString() string
- func (*HTTPStaticEnableV4) GetMessageName() string
- func (*HTTPStaticEnableV4) GetMessageType() api.MessageType
- func (m *HTTPStaticEnableV4) Marshal(b []byte) ([]byte, error)
- func (m *HTTPStaticEnableV4) Reset()
- func (m *HTTPStaticEnableV4) Size() (size int)
- func (m *HTTPStaticEnableV4) Unmarshal(b []byte) error
- type HTTPStaticEnableV4Reply
- func (*HTTPStaticEnableV4Reply) GetCrcString() string
- func (*HTTPStaticEnableV4Reply) GetMessageName() string
- func (*HTTPStaticEnableV4Reply) GetMessageType() api.MessageType
- func (m *HTTPStaticEnableV4Reply) Marshal(b []byte) ([]byte, error)
- func (m *HTTPStaticEnableV4Reply) Reset()
- func (m *HTTPStaticEnableV4Reply) Size() (size int)
- func (m *HTTPStaticEnableV4Reply) Unmarshal(b []byte) error
- type HTTPStaticEnableV5
- func (*HTTPStaticEnableV5) GetCrcString() string
- func (*HTTPStaticEnableV5) GetMessageName() string
- func (*HTTPStaticEnableV5) GetMessageType() api.MessageType
- func (m *HTTPStaticEnableV5) Marshal(b []byte) ([]byte, error)
- func (m *HTTPStaticEnableV5) Reset()
- func (m *HTTPStaticEnableV5) Size() (size int)
- func (m *HTTPStaticEnableV5) Unmarshal(b []byte) error
- type HTTPStaticEnableV5Reply
- func (*HTTPStaticEnableV5Reply) GetCrcString() string
- func (*HTTPStaticEnableV5Reply) GetMessageName() string
- func (*HTTPStaticEnableV5Reply) GetMessageType() api.MessageType
- func (m *HTTPStaticEnableV5Reply) Marshal(b []byte) ([]byte, error)
- func (m *HTTPStaticEnableV5Reply) Reset()
- func (m *HTTPStaticEnableV5Reply) Size() (size int)
- func (m *HTTPStaticEnableV5Reply) Unmarshal(b []byte) error
- type RPCService
Constants ¶
const ( APIFile = "http_static" APIVersion = "2.5.0" VersionCrc = 0xa4be530f )
Variables ¶
This section is empty.
Functions ¶
func AllMessages ¶
Messages returns list of all messages in this module.
Types ¶
type HTTPStaticEnableV4 ¶ added in v0.9.0
type HTTPStaticEnableV4 struct {
FifoSize uint32 `binapi:"u32,name=fifo_size" json:"fifo_size,omitempty"`
CacheSizeLimit uint32 `binapi:"u32,name=cache_size_limit" json:"cache_size_limit,omitempty"`
MaxAge uint32 `binapi:"u32,name=max_age,default=600" json:"max_age,omitempty"`
KeepaliveTimeout uint32 `binapi:"u32,name=keepalive_timeout,default=60" json:"keepalive_timeout,omitempty"`
MaxBodySize uint64 `binapi:"u64,name=max_body_size,default=8000" json:"max_body_size,omitempty"`
PreallocFifos uint32 `binapi:"u32,name=prealloc_fifos" json:"prealloc_fifos,omitempty"`
PrivateSegmentSize uint32 `binapi:"u32,name=private_segment_size" json:"private_segment_size,omitempty"`
WwwRoot string `binapi:"string[256],name=www_root" json:"www_root,omitempty"`
URI string `binapi:"string[256],name=uri" json:"uri,omitempty"`
}
Configure and enable the static http server
- fifo_size - size (in bytes) of the session FIFOs
- cache_size_limit - size (in bytes) of the in-memory file data cache
- max_age - how long a response is considered fresh (in seconds)
- max_body_size - maximum size of a request body (in bytes)
- keepalive_timeout - timeout during which client connection will stay open (in seconds)
- prealloc_fifos - number of preallocated fifos (usually 0)
- private_segment_size - fifo segment size (usually 0)
- www_root - html root path
- uri - bind URI, defaults to "tcp://0.0.0.0/80"
HTTPStaticEnableV4 defines message 'http_static_enable_v4'. Deprecated: the message will be removed in the future versions
func (*HTTPStaticEnableV4) GetCrcString ¶ added in v0.9.0
func (*HTTPStaticEnableV4) GetCrcString() string
func (*HTTPStaticEnableV4) GetMessageName ¶ added in v0.9.0
func (*HTTPStaticEnableV4) GetMessageName() string
func (*HTTPStaticEnableV4) GetMessageType ¶ added in v0.9.0
func (*HTTPStaticEnableV4) GetMessageType() api.MessageType
func (*HTTPStaticEnableV4) Marshal ¶ added in v0.9.0
func (m *HTTPStaticEnableV4) Marshal(b []byte) ([]byte, error)
func (*HTTPStaticEnableV4) Reset ¶ added in v0.9.0
func (m *HTTPStaticEnableV4) Reset()
func (*HTTPStaticEnableV4) Size ¶ added in v0.9.0
func (m *HTTPStaticEnableV4) Size() (size int)
func (*HTTPStaticEnableV4) Unmarshal ¶ added in v0.9.0
func (m *HTTPStaticEnableV4) Unmarshal(b []byte) error
type HTTPStaticEnableV4Reply ¶ added in v0.9.0
type HTTPStaticEnableV4Reply struct {
Retval int32 `binapi:"i32,name=retval" json:"retval,omitempty"`
}
HTTPStaticEnableV4Reply defines message 'http_static_enable_v4_reply'. Deprecated: the message will be removed in the future versions
func (*HTTPStaticEnableV4Reply) GetCrcString ¶ added in v0.9.0
func (*HTTPStaticEnableV4Reply) GetCrcString() string
func (*HTTPStaticEnableV4Reply) GetMessageName ¶ added in v0.9.0
func (*HTTPStaticEnableV4Reply) GetMessageName() string
func (*HTTPStaticEnableV4Reply) GetMessageType ¶ added in v0.9.0
func (*HTTPStaticEnableV4Reply) GetMessageType() api.MessageType
func (*HTTPStaticEnableV4Reply) Marshal ¶ added in v0.9.0
func (m *HTTPStaticEnableV4Reply) Marshal(b []byte) ([]byte, error)
func (*HTTPStaticEnableV4Reply) Reset ¶ added in v0.9.0
func (m *HTTPStaticEnableV4Reply) Reset()
func (*HTTPStaticEnableV4Reply) Size ¶ added in v0.9.0
func (m *HTTPStaticEnableV4Reply) Size() (size int)
func (*HTTPStaticEnableV4Reply) Unmarshal ¶ added in v0.9.0
func (m *HTTPStaticEnableV4Reply) Unmarshal(b []byte) error
type HTTPStaticEnableV5 ¶ added in v0.9.0
type HTTPStaticEnableV5 struct {
FifoSize uint32 `binapi:"u32,name=fifo_size" json:"fifo_size,omitempty"`
CacheSizeLimit uint32 `binapi:"u32,name=cache_size_limit" json:"cache_size_limit,omitempty"`
MaxAge uint32 `binapi:"u32,name=max_age,default=600" json:"max_age,omitempty"`
KeepaliveTimeout uint32 `binapi:"u32,name=keepalive_timeout,default=60" json:"keepalive_timeout,omitempty"`
MaxBodySize uint64 `binapi:"u64,name=max_body_size,default=8192" json:"max_body_size,omitempty"`
RxBuffThresh uint32 `binapi:"u32,name=rx_buff_thresh,default=1048576" json:"rx_buff_thresh,omitempty"`
PreallocFifos uint32 `binapi:"u32,name=prealloc_fifos" json:"prealloc_fifos,omitempty"`
PrivateSegmentSize uint32 `binapi:"u32,name=private_segment_size" json:"private_segment_size,omitempty"`
WwwRoot string `binapi:"string[256],name=www_root" json:"www_root,omitempty"`
URI string `binapi:"string[256],name=uri" json:"uri,omitempty"`
}
Configure and enable the static http server
- fifo_size - size (in bytes) of the session FIFOs
- cache_size_limit - size (in bytes) of the in-memory file data cache
- max_age - how long a response is considered fresh (in seconds)
- max_body_size - maximum size of a request body (in bytes)
- rx_buff_thresh - maximum size of a large memory allocation (in bytes)
- keepalive_timeout - timeout during which client connection will stay open (in seconds)
- prealloc_fifos - number of preallocated fifos (usually 0)
- private_segment_size - fifo segment size (usually 0)
- www_root - html root path
- uri - bind URI, defaults to "tcp://0.0.0.0/80"
HTTPStaticEnableV5 defines message 'http_static_enable_v5'.
func (*HTTPStaticEnableV5) GetCrcString ¶ added in v0.9.0
func (*HTTPStaticEnableV5) GetCrcString() string
func (*HTTPStaticEnableV5) GetMessageName ¶ added in v0.9.0
func (*HTTPStaticEnableV5) GetMessageName() string
func (*HTTPStaticEnableV5) GetMessageType ¶ added in v0.9.0
func (*HTTPStaticEnableV5) GetMessageType() api.MessageType
func (*HTTPStaticEnableV5) Marshal ¶ added in v0.9.0
func (m *HTTPStaticEnableV5) Marshal(b []byte) ([]byte, error)
func (*HTTPStaticEnableV5) Reset ¶ added in v0.9.0
func (m *HTTPStaticEnableV5) Reset()
func (*HTTPStaticEnableV5) Size ¶ added in v0.9.0
func (m *HTTPStaticEnableV5) Size() (size int)
func (*HTTPStaticEnableV5) Unmarshal ¶ added in v0.9.0
func (m *HTTPStaticEnableV5) Unmarshal(b []byte) error
type HTTPStaticEnableV5Reply ¶ added in v0.9.0
type HTTPStaticEnableV5Reply struct {
Retval int32 `binapi:"i32,name=retval" json:"retval,omitempty"`
}
HTTPStaticEnableV5Reply defines message 'http_static_enable_v5_reply'.
func (*HTTPStaticEnableV5Reply) GetCrcString ¶ added in v0.9.0
func (*HTTPStaticEnableV5Reply) GetCrcString() string
func (*HTTPStaticEnableV5Reply) GetMessageName ¶ added in v0.9.0
func (*HTTPStaticEnableV5Reply) GetMessageName() string
func (*HTTPStaticEnableV5Reply) GetMessageType ¶ added in v0.9.0
func (*HTTPStaticEnableV5Reply) GetMessageType() api.MessageType
func (*HTTPStaticEnableV5Reply) Marshal ¶ added in v0.9.0
func (m *HTTPStaticEnableV5Reply) Marshal(b []byte) ([]byte, error)
func (*HTTPStaticEnableV5Reply) Reset ¶ added in v0.9.0
func (m *HTTPStaticEnableV5Reply) Reset()
func (*HTTPStaticEnableV5Reply) Size ¶ added in v0.9.0
func (m *HTTPStaticEnableV5Reply) Size() (size int)
func (*HTTPStaticEnableV5Reply) Unmarshal ¶ added in v0.9.0
func (m *HTTPStaticEnableV5Reply) Unmarshal(b []byte) error
type RPCService ¶
type RPCService interface {
HTTPStaticEnableV4(ctx context.Context, in *HTTPStaticEnableV4) (*HTTPStaticEnableV4Reply, error)
HTTPStaticEnableV5(ctx context.Context, in *HTTPStaticEnableV5) (*HTTPStaticEnableV5Reply, error)
}
RPCService defines RPC service http_static.
func NewServiceClient ¶
func NewServiceClient(conn api.Connection) RPCService