Merge service to protocol

trunk/src/protocol/srs_service_st.hpp

@@ -0,0 +1,213 @@
+/**
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2013-2020 Winlin
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of
+ * this software and associated documentation files (the "Software"), to deal in
+ * the Software without restriction, including without limitation the rights to
+ * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+ * the Software, and to permit persons to whom the Software is furnished to do so,
+ * subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+ * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+ * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+ * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+ * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+#ifndef SRS_SERVICE_ST_HPP
+#define SRS_SERVICE_ST_HPP
+
+#include <srs_core.hpp>
+
+#include <string>
+
+#include <srs_protocol_io.hpp>
+
+// Wrap for coroutine.
+typedef void* srs_netfd_t;
+typedef void* srs_thread_t;
+typedef void* srs_cond_t;
+typedef void* srs_mutex_t;
+
+// Initialize st, requires epoll.
+extern srs_error_t srs_st_init();
+
+// Close the netfd, and close the underlayer fd.
+// @remark when close, user must ensure io completed.
+extern void srs_close_stfd(srs_netfd_t& stfd);
+
+// Set the FD_CLOEXEC of FD.
+extern srs_error_t srs_fd_closeexec(int fd);
+
+// Set the SO_REUSEADDR of fd.
+extern srs_error_t srs_fd_reuseaddr(int fd);
+
+// Set the SO_REUSEPORT of fd.
+extern srs_error_t srs_fd_reuseport(int fd);
+
+// Set the SO_KEEPALIVE of fd.
+extern srs_error_t srs_fd_keepalive(int fd);
+
+// Get current coroutine/thread.
+extern srs_thread_t srs_thread_self();
+
+// For client, to open socket and connect to server.
+// @param tm The timeout in srs_utime_t.
+extern srs_error_t srs_tcp_connect(std::string server, int port, srs_utime_t tm, srs_netfd_t* pstfd);
+
+// For server, listen at TCP endpoint.
+extern srs_error_t srs_tcp_listen(std::string ip, int port, srs_netfd_t* pfd);
+
+// For server, listen at UDP endpoint.
+extern srs_error_t srs_udp_listen(std::string ip, int port, srs_netfd_t* pfd);
+
+// Wrap for coroutine.
+extern srs_cond_t srs_cond_new();
+extern int srs_cond_destroy(srs_cond_t cond);
+extern int srs_cond_wait(srs_cond_t cond);
+extern int srs_cond_timedwait(srs_cond_t cond, srs_utime_t timeout);
+extern int srs_cond_signal(srs_cond_t cond);
+
+extern srs_mutex_t srs_mutex_new();
+extern int srs_mutex_destroy(srs_mutex_t mutex);
+extern int srs_mutex_lock(srs_mutex_t mutex);
+extern int srs_mutex_unlock(srs_mutex_t mutex);
+
+extern int srs_netfd_fileno(srs_netfd_t stfd);
+
+extern int srs_usleep(srs_utime_t usecs);
+
+extern srs_netfd_t srs_netfd_open_socket(int osfd);
+extern srs_netfd_t srs_netfd_open(int osfd);
+
+extern int srs_recvfrom(srs_netfd_t stfd, void *buf, int len, struct sockaddr *from, int *fromlen, srs_utime_t timeout);
+extern int srs_sendto(srs_netfd_t stfd, void *buf, int len, const struct sockaddr *to, int tolen, srs_utime_t timeout);
+extern int srs_recvmsg(srs_netfd_t stfd, struct msghdr *msg, int flags, srs_utime_t timeout);
+extern int srs_sendmsg(srs_netfd_t stfd, const struct msghdr *msg, int flags, srs_utime_t timeout);
+
+// @see http://man7.org/linux/man-pages/man2/sendmmsg.2.html
+#include <sys/socket.h>
+struct srs_mmsghdr {
+   struct msghdr msg_hdr;  /* Message header */
+   unsigned int  msg_len;  /* Number of bytes transmitted */
+};
+extern int srs_sendmmsg(srs_netfd_t stfd, struct srs_mmsghdr *msgvec, unsigned int vlen, int flags, srs_utime_t timeout);
+
+extern srs_netfd_t srs_accept(srs_netfd_t stfd, struct sockaddr *addr, int *addrlen, srs_utime_t timeout);
+
+extern ssize_t srs_read(srs_netfd_t stfd, void *buf, size_t nbyte, srs_utime_t timeout);
+
+extern bool srs_is_never_timeout(srs_utime_t tm);
+
+// The mutex locker.
+#define SrsLocker(instance) \
+    impl__SrsLocker _SRS_free_##instance(&instance)
+
+class impl__SrsLocker
+{
+private:
+    srs_mutex_t* lock;
+public:
+    impl__SrsLocker(srs_mutex_t* l) {
+        lock = l;
+        int r0 = srs_mutex_lock(*lock);
+        srs_assert(!r0);
+    }
+    virtual ~impl__SrsLocker() {
+        int r0 = srs_mutex_unlock(*lock);
+        srs_assert(!r0);
+    }
+};
+
+// the socket provides TCP socket over st,
+// that is, the sync socket mechanism.
+class SrsStSocket : public ISrsProtocolReadWriter
+{
+private:
+    // The recv/send timeout in srs_utime_t.
+    // @remark Use SRS_UTIME_NO_TIMEOUT for never timeout.
+    srs_utime_t rtm;
+    srs_utime_t stm;
+    // The recv/send data in bytes
+    int64_t rbytes;
+    int64_t sbytes;
+    // The underlayer st fd.
+    srs_netfd_t stfd;
+public:
+    SrsStSocket();
+    virtual ~SrsStSocket();
+public:
+    // Initialize the socket with stfd, user must manage it.
+    virtual srs_error_t initialize(srs_netfd_t fd);
+public:
+    virtual void set_recv_timeout(srs_utime_t tm);
+    virtual srs_utime_t get_recv_timeout();
+    virtual void set_send_timeout(srs_utime_t tm);
+    virtual srs_utime_t get_send_timeout();
+    virtual int64_t get_recv_bytes();
+    virtual int64_t get_send_bytes();
+public:
+    // @param nread, the actual read bytes, ignore if NULL.
+    virtual srs_error_t read(void* buf, size_t size, ssize_t* nread);
+    virtual srs_error_t read_fully(void* buf, size_t size, ssize_t* nread);
+    // @param nwrite, the actual write bytes, ignore if NULL.
+    virtual srs_error_t write(void* buf, size_t size, ssize_t* nwrite);
+    virtual srs_error_t writev(const iovec *iov, int iov_size, ssize_t* nwrite);
+};
+
+// The client to connect to server over TCP.
+// User must never reuse the client when close it.
+// Usage:
+//      SrsTcpClient client("127.0.0.1", 1935, 9 * SRS_UTIME_SECONDS);
+//      client.connect();
+//      client.write("Hello world!", 12, NULL);
+//      client.read(buf, 4096, NULL);
+// @remark User can directly free the object, which will close the fd.
+class SrsTcpClient : public ISrsProtocolReadWriter
+{
+private:
+    srs_netfd_t stfd;
+    SrsStSocket* io;
+private:
+    std::string host;
+    int port;
+    // The timeout in srs_utime_t.
+    srs_utime_t timeout;
+public:
+    // Constructor.
+    // @param h the ip or hostname of server.
+    // @param p the port to connect to.
+    // @param tm the timeout in srs_utime_t.
+    SrsTcpClient(std::string h, int p, srs_utime_t tm);
+    virtual ~SrsTcpClient();
+public:
+    // Connect to server over TCP.
+    // @remark We will close the exists connection before do connect.
+    virtual srs_error_t connect();
+private:
+    // Close the connection to server.
+    // @remark User should never use the client when close it.
+    virtual void close();
+// Interface ISrsProtocolReadWriter
+public:
+    virtual void set_recv_timeout(srs_utime_t tm);
+    virtual srs_utime_t get_recv_timeout();
+    virtual void set_send_timeout(srs_utime_t tm);
+    virtual srs_utime_t get_send_timeout();
+    virtual int64_t get_recv_bytes();
+    virtual int64_t get_send_bytes();
+    virtual srs_error_t read(void* buf, size_t size, ssize_t* nread);
+    virtual srs_error_t read_fully(void* buf, size_t size, ssize_t* nread);
+    virtual srs_error_t write(void* buf, size_t size, ssize_t* nwrite);
+    virtual srs_error_t writev(const iovec *iov, int iov_size, ssize_t* nwrite);
+};
+
+#endif
+