Lib NetworkMessage

[dalvorsn 268]

NetworkMessage

Autor: DalvoDescrição: Lib direcionada a manipulação de bytes, feita com intuito de auxiliar nos opcodes para otclient, porém tem uma vasta gama de utilidades.

 

NetworkMessage = {}function NetworkMessage.create(pdata)	-- NetworkMessage.create([pdata])	-- @params	--	'pdata': string	-- Instancia a classe NetworkMessage, se pdata é fornecido é definido o atributo data igual a pdata e size igual a #pdata	return setmetatable({ data = pdata or "", size = pdata and #pdata or 0, pos = 1}, { __index = NetworkMessage })endfunction NetworkMessage:reset()	-- NetworkMessage.reset(self)	-- self:reset()	-- @params	-- 	'self': table	-- Reinicia os atributos do objeto	self.data = ""	self.size = 0	self.pos  = 1endfunction NetworkMessage:setBuffer(buffer)	-- NetworkMessage.setBuffer(self, buffer)	-- self:setBuffer(buffer)	-- @params	-- 	'self': table	--  'buffer': string	-- Define 'buffer' como atributo data	if not type(buffer) == "string" then		return false	end	self.data = buffer	self.size = #buffer	self.pos = 1endfunction NetworkMessage:getBuffer()	-- NetworkMessage.getBuffer(self)	-- self:getBuffer()	-- @params	--  'self': table	-- Retorna o atributo 'data'	return self.dataendfunction NetworkMessage:getSize()	-- NetworkMessage.getSize(self)	-- self:getSize()	-- @params	--  'self': table	-- Retorna o atributo 'size'	return self.sizeendfunction NetworkMessage:getRanges(byteCount, signed)	-- NetworkMessage.getRanges(self, byteCount, signed)	-- self:getRanges(byteCount, signed)	-- @params	-- 	'self': table	-- 	'byteCount': number	--  'signed': boolean	-- Função interna usada para calcular o limite do valor de 'byteCount' bytes, se signed é true reajusta seu valor para signed	local min, max = 0, ((256^byteCount) -1)	if(signed)then		max = math.floor(max/2)		min = -max-1	end	return -min, maxendfunction NetworkMessage:canRead(size)	-- NetworkMessage.canRead(self, size)	-- self:canRead(size)	-- @params	--  'self': table	--  'size': number	-- Verifica se pode ser lido o numero 'size' de bytes, retorna um booleano	return (self.pos + size) > (self.size + 1)endfunction NetworkMessage:readBytes(byteCount, signed)	-- NetworkMessage.readBytes(self, byteCount, signed)	-- self:readBytes(byteCount, signed)	-- @params	--  'self': table	--  'byteCount': number	--  'signed': boolean	-- Tenta ler 'byteCount' numero de bytes, retorna o valor numerico dos bytes	-- se possivel a leitura, e false se não. Se signed é true reajusta valor para signed	if self:canRead(byteCount) then return false end	local min, _ = self:getRanges(byteCount, signed)	local value = 0	for byte = 1, byteCount do		value = value + ( self.data:byte(self.pos) * (256^(byte-1)) )		self.pos = self.pos + 1	end	return value + minendfunction NetworkMessage:addBytes(value, count, signed)	-- NetworkMessage.addBytes(self, value, count, signed)	-- self:addBytes(value, count, signed)	-- @params	--  'self': table	-- 	'value': number	--  'count':number	--  'signed':boolean	-- Tenta escrever 'value' em 'count' bytes, se 'value' for maior que o numero de bytes	-- suporta retorna false. Se signed é true reajusta valor para signed	if signed then		value = value * 2	end	if value >= (256^count) then		return false	end	for byte = count, 1, -1 do		local power = (256 ^ (byte-1))		self.data = self.data .. string.char( math.floor(value/power) )		value = value % power	end	self.size = self.size + count	self.pos = self.pos + count	return trueend-- Metodos para pegar valoresfunction NetworkMessage:getU8()	return self:readBytes(1, false)endfunction NetworkMessage:getU16()	return self:readBytes(2, false)endfunction NetworkMessage:getU32()	return self:readBytes(4, false)endfunction NetworkMessage:getU64()	return self:readBytes(8, false)endfunction NetworkMessage:getI8()	return self:readBytes(1, true)endfunction NetworkMessage:getI16()	return self:readBytes(2, true)endfunction NetworkMessage:getI32()	return self:readBytes(4, true)endfunction NetworkMessage:getI64()	return self:readBytes(8, true)end-- Metodos para adição de valoresfunction NetworkMessage:addU8(value)	return self:addBytes(value, 1, false)endfunction NetworkMessage:addU16(value)	return self:addBytes(value, 2, false)endfunction NetworkMessage:addU32(value)	return self:addBytes(value, 4, false)endfunction NetworkMessage:addU64(value)	return self:addBytes(value, 8, false)endfunction NetworkMessage:addI8(value)	return self:addBytes(value, 1, true)endfunction NetworkMessage:addI16(value)	return self:addBytes(value, 2, true)endfunction NetworkMessage:addI32(value)	return self:addBytes(value, 4, true)endfunction NetworkMessage:addI64(value)	return self:addBytes(value, 8, true)endfunction NetworkMessage:addString(str)	-- NetworkMessage.addString(self, str)	-- self:addString(str)	-- @params	--  'self': table	--  'str': string	-- Tenta adicionar 'str', se o tamanho supera dois bytes, retorna false	if not self:addU16(#str) then		return false	end	self.data = self.data .. str	self.size = self.size + #str	self.pos = self.pos + #str	return trueendfunction NetworkMessage:getString()	-- NetworkMessage.getString(self)	-- self:getString()	-- @params	--  'self': table	-- Tenta ler a string e retorna-la em caso de sucesso, se falho retorna false	local size = self:getU16()	if not (size and self:canRead(size)) then return false end	local str = ""	for byte=0, size-1 do		str = str .. string.char(self.data:byte(self.pos + byte))	end	self.pos = self.pos + size	return strend

Link da lib

Editado Outubro 6, 2016 por dalvorsn
Inserção do link da lib

[garep 14]

cade a lib ?

[dalvorsn 268]

45 minutos atrás, garep disse:

cade a lib ?

Quando eu postei o forum tinha um bbcode para o pastebin, ficava bem melhor a formatação, mas migraram e tiraram, o link em si ainda existe. Vou editar o topico

[Poccnn 385]

Inseri no tópico o link da lib.

Dalvo. Tu tais de parabéns. Ficou muito bom a lib.

[dalvorsn 268]

12 minutos atrás, Poccnn disse:

Inseri no tópico o link da lib.

Dalvo. Tu tais de parabéns. Ficou muito bom a lib.

Valeu hehe

Pena que o povo parece que nem entende muito bem pra que serve, mas tudo bem, se alguem fizer bom uso ja ta valendo

[Josegvb 87]

não sei pra oq é isso rs mas paresce legal e seus conteudos sempre sao optimos ^^ entao rep+

[dalvorsn 268]

5 minutos atrás, Josegvb disse:

não sei pra oq é isso rs mas paresce legal e seus conteudos sempre sao optimos ^^ entao rep+

 

Os pacotes de rede pra ficarem mais eficientes geralmente sao convertidos em estruturas binarias, de forma a ser passada apenas os dados e não todo um lixo de metadados como index de arrays, strings pra pattern e etc. A lib faz justamente essa serialização. Os opcodes seriam um bom lugar para se usar isso por exemplo, porém na maioria das distribuições o popString é bugado, ele não aceita caracteres não representaveis, ai buga toda a string binaria.

Mas a biblioteca é lua puro, então pode-se facilmente usar em qualquer outra coisa que não seja otserv.