tcp

README

xk6-tcp

A k6 extension for sending strings to TCP port

Build

To build a k6 binary with this plugin, first ensure you have the prerequisites:

• Go toolchain
• Git

Then:

1. Install xk6:

go install github.com/k6io/xk6/cmd/xk6@latest

1. Build the binary:

xk6 build master \
  --with github.com/snormore/xk6-tcp

Example

import tcp from "k6/x/tcp";
import { check } from "k6";

const conn = tcp.connect("host:port");

export default function () {
  tcp.writeLn(conn, "Say Hello");
  let res = String.fromCharCode(...tcp.read(conn, 1024));
  check(res, {
    "verify ag tag": (res) => res.includes("Hello"),
  });
  tcp.close(conn);
}

Documentation

Index

• type TCP
  • func (tcp *TCP) Close(conn net.Conn) error
  • func (tcp *TCP) Connect(addr string) (net.Conn, error)
  • func (tcp *TCP) Read(conn net.Conn, size int) ([]byte, error)
  • func (tcp *TCP) Write(conn net.Conn, data []byte) error
  • func (tcp *TCP) WriteLn(conn net.Conn, data []byte) error

Types

type TCP

type TCP struct{}

func (*TCP) Close

func (tcp *TCP) Close(conn net.Conn) error

func (*TCP) Connect

func (tcp *TCP) Connect(addr string) (net.Conn, error)

func (*TCP) Read

func (tcp *TCP) Read(conn net.Conn, size int) ([]byte, error)

func (*TCP) Write

func (tcp *TCP) Write(conn net.Conn, data []byte) error

func (*TCP) WriteLn

func (tcp *TCP) WriteLn(conn net.Conn, data []byte) error